@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.57 → 21.7.0-canary.58

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

@@ -0,0 +1,49 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditingConfigMiddleware = void 0;
+const constants_1 = require("./constants");
+const utils_1 = require("../utils/utils");
+const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
+/**
+ * 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.
+ */
+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[constants_1.QUERY_PARAM_EDITING_SECRET];
+            if (secret !== (0, utils_1.getJssEditingSecret)()) {
+                sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
+                res.status(401).end('Missing or invalid editing secret');
+            }
+            const components = Array.isArray(this.config.components)
+                ? this.config.components
+                : Array.from(this.config.components.keys());
+            return res.status(200).json({
+                components,
+                packages: this.config.metadata.packages,
+            });
+        });
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+}
+exports.EditingConfigMiddleware = EditingConfigMiddleware;

package/dist/cjs/editing/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VercelEditingDataCache = exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = void 0;
+exports.EditingConfigMiddleware = exports.VercelEditingDataCache = exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = void 0;
 var editing_data_cache_1 = require("./editing-data-cache");
 Object.defineProperty(exports, "EditingDataDiskCache", { enumerable: true, get: function () { return editing_data_cache_1.EditingDataDiskCache; } });
 var editing_data_middleware_1 = require("./editing-data-middleware");
@@ -13,3 +13,5 @@ Object.defineProperty(exports, "ServerlessEditingDataService", { enumerable: tru
 Object.defineProperty(exports, "editingDataService", { enumerable: true, get: function () { return editing_data_service_1.editingDataService; } });
 var vercel_editing_data_cache_1 = require("./vercel-editing-data-cache");
 Object.defineProperty(exports, "VercelEditingDataCache", { enumerable: true, get: function () { return vercel_editing_data_cache_1.VercelEditingDataCache; } });
+var editing_config_middleware_1 = require("./editing-config-middleware");
+Object.defineProperty(exports, "EditingConfigMiddleware", { enumerable: true, get: function () { return editing_config_middleware_1.EditingConfigMiddleware; } });

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

@@ -0,0 +1,45 @@
+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 { QUERY_PARAM_EDITING_SECRET } from './constants';
+import { getJssEditingSecret } from '../utils/utils';
+import { debug } from '@sitecore-jss/sitecore-jss';
+/**
+ * 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];
+            if (secret !== getJssEditingSecret()) {
+                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
+                res.status(401).end('Missing or invalid editing secret');
+            }
+            const components = Array.isArray(this.config.components)
+                ? this.config.components
+                : Array.from(this.config.components.keys());
+            return res.status(200).json({
+                components,
+                packages: this.config.metadata.packages,
+            });
+        });
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+}

package/dist/esm/editing/index.js

@@ -3,3 +3,4 @@ export { EditingDataMiddleware } from './editing-data-middleware';
 export { EditingRenderMiddleware, } from './editing-render-middleware';
 export { BasicEditingDataService, ServerlessEditingDataService, editingDataService, } from './editing-data-service';
 export { VercelEditingDataCache } from './vercel-editing-data-cache';
+export { EditingConfigMiddleware, } from './editing-config-middleware';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "21.7.0-canary.57",
+  "version": "21.7.0-canary.58",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -72,9 +72,9 @@
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.7.0-canary.57",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^21.7.0-canary.57",
-    "@sitecore-jss/sitecore-jss-react": "^21.7.0-canary.57",
+    "@sitecore-jss/sitecore-jss": "^21.7.0-canary.58",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^21.7.0-canary.58",
+    "@sitecore-jss/sitecore-jss-react": "^21.7.0-canary.58",
     "@vercel/kv": "^0.2.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
@@ -83,7 +83,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "6cae20dcb45cd56a486d630a56150ef51d797b1a",
+  "gitHead": "c7bbfe5c5e1ea3ee34590af2323917df27969e67",
   "files": [
     "dist",
     "types",

package/types/editing/editing-config-middleware.d.ts

@@ -0,0 +1,29 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+import { Metadata } from '@sitecore-jss/sitecore-jss-dev-tools';
+export type EditingConfigMiddlewareConfig = {
+    /**
+     * Components available in the application
+     */
+    components: string[] | Map<string, unknown>;
+    /**
+     * Application metadata
+     */
+    metadata: Metadata;
+};
+/**
+ * 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 declare class EditingConfigMiddleware {
+    protected config: EditingConfigMiddlewareConfig;
+    /**
+     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
+     */
+    constructor(config: EditingConfigMiddlewareConfig);
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}

package/types/editing/index.d.ts

@@ -4,3 +4,4 @@ export { EditingDataMiddleware, EditingDataMiddlewareConfig } from './editing-da
 export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, } from './editing-render-middleware';
 export { EditingPreviewData, EditingDataService, BasicEditingDataService, BasicEditingDataServiceConfig, ServerlessEditingDataService, ServerlessEditingDataServiceConfig, editingDataService, } from './editing-data-service';
 export { VercelEditingDataCache } from './vercel-editing-data-cache';
+export { EditingConfigMiddleware, EditingConfigMiddlewareConfig, } from './editing-config-middleware';