@sitecore-content-sdk/nextjs 1.3.0-canary.9 → 1.4.0-canary.2

package/dist/esm/editing/codegen/import-map.js

@@ -1,81 +1,92 @@
-import React, { Children, Fragment, createElement, cloneElement, isValidElement, useActionState, useCallback, useContext, useDeferredValue, useEffect, useId, useLayoutEffect, useMemo, useOptimistic, useReducer, useRef, useState, useSyncExternalStore, useTransition, forwardRef, lazy, memo, Suspense, } from 'react';
-import { Link, Text, RichText, useSitecore, NextImage, Placeholder, Image, File, useComponentProps, withDatasourceCheck, CdpHelper, withSitecore, } from '../..';
-export const defaultImportEntries = [
-    /* -------------------- React -------------------- */
-    {
-        module: 'react',
-        exports: [
-            { name: 'default', value: React },
-            { name: 'Children', value: Children },
-            { name: 'Fragment', value: Fragment },
-            { name: 'createElement', value: createElement },
-            { name: 'cloneElement', value: cloneElement },
-            { name: 'isValidElement', value: isValidElement },
-            // Hooks
-            { name: 'useActionState', value: useActionState },
-            { name: 'useCallback', value: useCallback },
-            { name: 'useContext', value: useContext },
-            { name: 'useDeferredValue', value: useDeferredValue },
-            { name: 'useEffect', value: useEffect },
-            { name: 'useId', value: useId },
-            { name: 'useLayoutEffect', value: useLayoutEffect },
-            { name: 'useMemo', value: useMemo },
-            { name: 'useOptimistic', value: useOptimistic },
-            { name: 'useReducer', value: useReducer },
-            { name: 'useRef', value: useRef },
-            { name: 'useState', value: useState },
-            { name: 'useSyncExternalStore', value: useSyncExternalStore },
-            { name: 'useTransition', value: useTransition },
-            // Performance helpers
-            { name: 'forwardRef', value: forwardRef },
-            { name: 'lazy', value: lazy },
-            { name: 'memo', value: memo },
-            { name: 'Suspense', value: Suspense },
-        ],
-    },
-    /* ------------- Sitecore Content‑SDK ------------- */
-    {
-        module: '@sitecore-content-sdk/nextjs',
-        exports: [
-            { name: 'Link', value: Link },
-            { name: 'Text', value: Text },
-            { name: 'RichText', value: RichText },
-            { name: 'Placeholder', value: Placeholder },
-            { name: 'NextImage', value: NextImage },
-            { name: 'Image', value: Image },
-            { name: 'File', value: File },
-            { name: 'useSitecore', value: useSitecore },
-            { name: 'withSitecore', value: withSitecore },
-            { name: 'useComponentProps', value: useComponentProps },
-            { name: 'withDatasourceCheck', value: withDatasourceCheck },
-            { name: 'CdpHelper', value: CdpHelper },
-        ],
-    },
-];
-export const combineImportEntries = (defaultImportEntries, generatedImportEntries) => {
-    const combinedEntries = [];
-    const importMap = new Map();
-    // add generated entries to the map, overwriting existing ones
-    generatedImportEntries.forEach((entry) => {
-        importMap.set(entry.module, entry);
-    });
-    // add default entries to the map, if not present
-    defaultImportEntries.forEach((defaultEntry) => {
-        const mapEntry = importMap.get(defaultEntry.module);
-        if (mapEntry) {
-            defaultEntry.exports.forEach((defaultExportsEntry) => {
-                if (!mapEntry.exports.some((e) => e.name === defaultExportsEntry.name)) {
-                    mapEntry.exports.push(defaultExportsEntry);
-                }
-            });
-        }
-        else {
-            importMap.set(defaultEntry.module, defaultEntry);
-        }
-    });
-    // convert map back to array
-    importMap.forEach((value) => {
-        combinedEntries.push(value);
-    });
-    return combinedEntries;
-};
+import React, { Children, Fragment, createElement, cloneElement, isValidElement, useActionState, useCallback, useContext, useDeferredValue, useEffect, useId, useLayoutEffect, useMemo, useOptimistic, useReducer, useRef, useState, useSyncExternalStore, useTransition, forwardRef, lazy, memo, Suspense, } from 'react';
+import { Link, Text, RichText, useSitecore, NextImage, Placeholder, Image, File, useComponentProps, withDatasourceCheck, CdpHelper, withSitecore, } from '../..';
+/**
+ * The default import entries for the import map.
+ * @public
+ */
+export const defaultImportEntries = [
+    /* -------------------- React -------------------- */
+    {
+        module: 'react',
+        exports: [
+            { name: 'default', value: React },
+            { name: 'Children', value: Children },
+            { name: 'Fragment', value: Fragment },
+            { name: 'createElement', value: createElement },
+            { name: 'cloneElement', value: cloneElement },
+            { name: 'isValidElement', value: isValidElement },
+            // Hooks
+            { name: 'useActionState', value: useActionState },
+            { name: 'useCallback', value: useCallback },
+            { name: 'useContext', value: useContext },
+            { name: 'useDeferredValue', value: useDeferredValue },
+            { name: 'useEffect', value: useEffect },
+            { name: 'useId', value: useId },
+            { name: 'useLayoutEffect', value: useLayoutEffect },
+            { name: 'useMemo', value: useMemo },
+            { name: 'useOptimistic', value: useOptimistic },
+            { name: 'useReducer', value: useReducer },
+            { name: 'useRef', value: useRef },
+            { name: 'useState', value: useState },
+            { name: 'useSyncExternalStore', value: useSyncExternalStore },
+            { name: 'useTransition', value: useTransition },
+            // Performance helpers
+            { name: 'forwardRef', value: forwardRef },
+            { name: 'lazy', value: lazy },
+            { name: 'memo', value: memo },
+            { name: 'Suspense', value: Suspense },
+        ],
+    },
+    /* ------------- Sitecore Content‑SDK ------------- */
+    {
+        module: '@sitecore-content-sdk/nextjs',
+        exports: [
+            { name: 'Link', value: Link },
+            { name: 'Text', value: Text },
+            { name: 'RichText', value: RichText },
+            { name: 'Placeholder', value: Placeholder },
+            { name: 'NextImage', value: NextImage },
+            { name: 'Image', value: Image },
+            { name: 'File', value: File },
+            { name: 'useSitecore', value: useSitecore },
+            { name: 'withSitecore', value: withSitecore },
+            { name: 'useComponentProps', value: useComponentProps },
+            { name: 'withDatasourceCheck', value: withDatasourceCheck },
+            { name: 'CdpHelper', value: CdpHelper },
+        ],
+    },
+];
+/**
+ * Combines the default import entries with the generated import entries.
+ * @param {ImportEntry[]} defaultImportEntries - The default import entries.
+ * @param {ImportEntry[]} generatedImportEntries - The generated import entries.
+ * @returns {ImportEntry[]} The combined import entries.
+ * @public
+ */
+export const combineImportEntries = (defaultImportEntries, generatedImportEntries) => {
+    const combinedEntries = [];
+    const importMap = new Map();
+    // add generated entries to the map, overwriting existing ones
+    generatedImportEntries.forEach((entry) => {
+        importMap.set(entry.module, entry);
+    });
+    // add default entries to the map, if not present
+    defaultImportEntries.forEach((defaultEntry) => {
+        const mapEntry = importMap.get(defaultEntry.module);
+        if (mapEntry) {
+            defaultEntry.exports.forEach((defaultExportsEntry) => {
+                if (!mapEntry.exports.some((e) => e.name === defaultExportsEntry.name)) {
+                    mapEntry.exports.push(defaultExportsEntry);
+                }
+            });
+        }
+        else {
+            importMap.set(defaultEntry.module, defaultEntry);
+        }
+    });
+    // convert map back to array
+    importMap.forEach((value) => {
+        combinedEntries.push(value);
+    });
+    return combinedEntries;
+};

package/dist/esm/editing/codegen/index.js

@@ -1 +1 @@
-export { defaultImportEntries, combineImportEntries } from './import-map';
+export { defaultImportEntries, combineImportEntries } from './import-map';

package/dist/esm/editing/constants.js

@@ -1,7 +1,7 @@
-export const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = 'x-vercel-protection-bypass';
-export const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
-/**
- * Headers that should be passed along to (Editing Chromes handler) SSR request.
- * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
- */
-export const EDITING_PASS_THROUGH_HEADERS = ['authorization', 'cookie'];
+export const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = 'x-vercel-protection-bypass';
+export const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
+/**
+ * Headers that should be passed along to (Editing Chromes handler) SSR request.
+ * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
+ */
+export const EDITING_PASS_THROUGH_HEADERS = ['authorization', 'cookie'];

package/dist/esm/editing/editing-config-middleware.js

@@ -1,65 +1,66 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-content-sdk/core/editing';
-import { debug } from '@sitecore-content-sdk/core';
-import { getEnforcedCorsHeaders } from '@sitecore-content-sdk/core/utils';
-import { EditMode } from '@sitecore-content-sdk/core/layout';
-import { getEditingSecret } from '../utils/utils';
-/**
- * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
- * provides configuration information to determine feature compatibility on Pages side.
- */
-export class EditingConfigMiddleware {
-    /**
-     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
-     */
-    constructor(config) {
-        this.config = config;
-        this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
-            const secret = _req.query[QUERY_PARAM_EDITING_SECRET];
-            const corsHeaders = getEnforcedCorsHeaders({
-                requestMethod: _req.method,
-                headers: _req.headers,
-                presetCorsHeader: res === null || res === void 0 ? void 0 : res.getHeader('Access-Control-Allow-Origin'),
-                allowedOrigins: EDITING_ALLOWED_ORIGINS,
-            });
-            if (!corsHeaders) {
-                debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
-                return res.status(401).json({ message: 'Invalid origin' });
-            }
-            Object.keys(corsHeaders).forEach((key) => {
-                res.setHeader(key, corsHeaders[key]);
-            });
-            if (secret !== getEditingSecret()) {
-                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getEditingSecret());
-                return res.status(401).json({ message: 'Missing or invalid editing secret' });
-            }
-            // Handle preflight request
-            if (_req.method === 'OPTIONS') {
-                debug.editing('preflight request');
-                // CORS headers are set by enforceCors
-                return res.status(204).send(null);
-            }
-            const components = Array.from(this.config.components.keys());
-            return res.status(200).json({
-                components,
-                packages: this.config.metadata.packages,
-                editMode: EditMode.Metadata,
-            });
-        });
-    }
-    /**
-     * Gets the Next.js API route handler
-     * @returns middleware handler
-     */
-    getHandler() {
-        return this.handler;
-    }
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-content-sdk/core/editing';
+import { debug } from '@sitecore-content-sdk/core';
+import { getEnforcedCorsHeaders } from '@sitecore-content-sdk/core/utils';
+import { EditMode } from '@sitecore-content-sdk/core/layout';
+import { getEditingSecret } from '../utils/utils';
+/**
+ * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
+ * provides configuration information to determine feature compatibility on Pages side.
+ * @public
+ */
+export class EditingConfigMiddleware {
+    /**
+     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
+     */
+    constructor(config) {
+        this.config = config;
+        this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
+            const secret = _req.query[QUERY_PARAM_EDITING_SECRET];
+            const corsHeaders = getEnforcedCorsHeaders({
+                requestMethod: _req.method,
+                headers: _req.headers,
+                presetCorsHeader: res === null || res === void 0 ? void 0 : res.getHeader('Access-Control-Allow-Origin'),
+                allowedOrigins: EDITING_ALLOWED_ORIGINS,
+            });
+            if (!corsHeaders) {
+                debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
+                return res.status(401).json({ message: 'Invalid origin' });
+            }
+            Object.keys(corsHeaders).forEach((key) => {
+                res.setHeader(key, corsHeaders[key]);
+            });
+            if (secret !== getEditingSecret()) {
+                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getEditingSecret());
+                return res.status(401).json({ message: 'Missing or invalid editing secret' });
+            }
+            // Handle preflight request
+            if (_req.method === 'OPTIONS') {
+                debug.editing('preflight request');
+                // CORS headers are set by enforceCors
+                return res.status(204).send(null);
+            }
+            const components = Array.from(this.config.components.keys());
+            return res.status(200).json({
+                components,
+                packages: this.config.metadata.packages,
+                editMode: EditMode.Metadata,
+            });
+        });
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+}