@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.8 → 22.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +202 -202
- package/README.md +12 -10
- package/context.d.ts +1 -0
- package/context.js +1 -0
- package/dist/cjs/ComponentBuilder.js +63 -0
- package/dist/cjs/components/BYOCWrapper.js +47 -0
- package/dist/cjs/components/FEaaSWrapper.js +49 -0
- package/dist/cjs/components/Link.js +5 -4
- package/dist/cjs/components/NextImage.js +3 -14
- package/dist/cjs/components/RichText.js +11 -15
- package/dist/cjs/context/context.js +83 -0
- package/dist/cjs/context/index.js +5 -0
- package/dist/cjs/editing/constants.js +6 -0
- package/dist/cjs/editing/editing-config-middleware.js +49 -0
- package/dist/cjs/editing/editing-data-middleware.js +3 -3
- package/dist/cjs/editing/editing-data-service.js +16 -8
- package/dist/cjs/editing/editing-render-middleware.js +25 -11
- package/dist/cjs/editing/feaas-render-middleware.js +87 -0
- package/dist/cjs/editing/index.js +7 -1
- package/dist/cjs/editing/render-middleware.js +27 -0
- package/dist/cjs/editing/vercel-editing-data-cache.js +48 -0
- package/dist/cjs/graphql/index.js +7 -0
- package/dist/cjs/index.js +38 -14
- package/dist/cjs/middleware/index.js +3 -5
- package/dist/cjs/middleware/middleware.js +18 -2
- package/dist/cjs/middleware/multisite-middleware.js +14 -8
- package/dist/cjs/middleware/personalize-middleware.js +62 -56
- package/dist/cjs/middleware/redirects-middleware.js +64 -21
- package/dist/cjs/services/base-graphql-sitemap-service.js +7 -6
- package/dist/cjs/services/component-props-service.js +6 -6
- package/dist/cjs/site/index.js +5 -0
- package/dist/cjs/utils/index.js +11 -0
- package/dist/cjs/{utils.js → utils/utils.js} +7 -16
- package/dist/esm/ComponentBuilder.js +59 -0
- package/dist/esm/components/BYOCWrapper.js +42 -0
- package/dist/esm/components/FEaaSWrapper.js +44 -0
- package/dist/esm/components/Link.js +5 -4
- package/dist/esm/components/NextImage.js +2 -12
- package/dist/esm/components/RichText.js +11 -15
- package/dist/esm/context/context.js +79 -0
- package/dist/esm/context/index.js +1 -0
- package/dist/esm/editing/constants.js +3 -0
- package/dist/esm/editing/editing-config-middleware.js +45 -0
- package/dist/esm/editing/editing-data-middleware.js +2 -2
- package/dist/esm/editing/editing-data-service.js +14 -6
- package/dist/esm/editing/editing-render-middleware.js +25 -11
- package/dist/esm/editing/feaas-render-middleware.js +83 -0
- package/dist/esm/editing/index.js +3 -0
- package/dist/esm/editing/render-middleware.js +23 -0
- package/dist/esm/editing/vercel-editing-data-cache.js +44 -0
- package/dist/esm/graphql/index.js +1 -0
- package/dist/esm/index.js +10 -7
- package/dist/esm/middleware/index.js +1 -2
- package/dist/esm/middleware/middleware.js +18 -2
- package/dist/esm/middleware/multisite-middleware.js +14 -8
- package/dist/esm/middleware/personalize-middleware.js +65 -59
- package/dist/esm/middleware/redirects-middleware.js +64 -21
- package/dist/esm/services/base-graphql-sitemap-service.js +7 -6
- package/dist/esm/services/component-props-service.js +6 -6
- package/dist/esm/site/index.js +1 -0
- package/dist/esm/utils/index.js +2 -0
- package/dist/esm/{utils.js → utils/utils.js} +7 -13
- package/graphql.d.ts +1 -0
- package/graphql.js +1 -0
- package/package.json +15 -12
- package/site.d.ts +1 -0
- package/site.js +1 -0
- package/types/ComponentBuilder.d.ts +61 -0
- package/types/components/BYOCWrapper.d.ts +19 -0
- package/types/components/ComponentPropsContext.d.ts +1 -0
- package/types/components/FEaaSWrapper.d.ts +21 -0
- package/types/components/Link.d.ts +2 -1
- package/types/components/NextImage.d.ts +3 -3
- package/types/components/Placeholder.d.ts +3 -1
- package/types/components/RichText.d.ts +6 -4
- package/types/context/context.d.ts +116 -0
- package/types/context/index.d.ts +1 -0
- package/types/editing/constants.d.ts +3 -0
- package/types/editing/editing-config-middleware.d.ts +29 -0
- package/types/editing/editing-data-service.d.ts +12 -4
- package/types/editing/editing-render-middleware.d.ts +2 -1
- package/types/editing/feaas-render-middleware.d.ts +32 -0
- package/types/editing/index.d.ts +3 -0
- package/types/editing/render-middleware.d.ts +15 -0
- package/types/editing/vercel-editing-data-cache.d.ts +19 -0
- package/types/graphql/index.d.ts +1 -0
- package/types/index.d.ts +12 -9
- package/types/middleware/index.d.ts +1 -2
- package/types/middleware/middleware.d.ts +8 -0
- package/types/middleware/multisite-middleware.d.ts +15 -0
- package/types/middleware/personalize-middleware.d.ts +53 -14
- package/types/middleware/redirects-middleware.d.ts +1 -1
- package/types/services/base-graphql-sitemap-service.d.ts +7 -10
- package/types/services/component-props-service.d.ts +2 -2
- package/types/sharedTypes/component-props.d.ts +5 -1
- package/types/sharedTypes/module-factory.d.ts +33 -0
- package/types/site/index.d.ts +1 -0
- package/types/utils/index.d.ts +2 -0
- package/types/{utils.d.ts → utils/utils.d.ts} +2 -0
- package/utils.d.ts +1 -0
- package/utils.js +1 -0
- package/types/sharedTypes/component-module.d.ts +0 -13
- /package/dist/cjs/sharedTypes/{component-module.js → module-factory.js} +0 -0
- /package/dist/esm/sharedTypes/{component-module.js → module-factory.js} +0 -0
|
@@ -14,21 +14,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
14
14
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
exports.NextImage =
|
|
17
|
+
exports.NextImage = void 0;
|
|
18
18
|
const media_1 = require("@sitecore-jss/sitecore-jss/media");
|
|
19
19
|
const prop_types_1 = __importDefault(require("prop-types"));
|
|
20
20
|
const react_1 = __importDefault(require("react"));
|
|
21
21
|
const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
|
|
22
22
|
const image_1 = __importDefault(require("next/image"));
|
|
23
|
-
const sitecoreLoader = ({ src, width }) => {
|
|
24
|
-
const [root, paramString] = src.split('?');
|
|
25
|
-
const params = new URLSearchParams(paramString);
|
|
26
|
-
params.set('mw', width.toString());
|
|
27
|
-
return `${root}?${params}`;
|
|
28
|
-
};
|
|
29
|
-
exports.sitecoreLoader = sitecoreLoader;
|
|
30
23
|
const NextImage = (_a) => {
|
|
31
|
-
var { editable, imageParams, field, mediaUrlPrefix, fill, priority } = _a, otherProps = __rest(_a, ["editable", "imageParams", "field", "mediaUrlPrefix", "fill", "priority"]);
|
|
24
|
+
var { editable = true, imageParams, field, mediaUrlPrefix, fill, priority } = _a, otherProps = __rest(_a, ["editable", "imageParams", "field", "mediaUrlPrefix", "fill", "priority"]);
|
|
32
25
|
// next handles src and we use a custom loader,
|
|
33
26
|
// throw error if these are present
|
|
34
27
|
if (otherProps.src) {
|
|
@@ -62,9 +55,8 @@ const NextImage = (_a) => {
|
|
|
62
55
|
delete imageProps.width;
|
|
63
56
|
delete imageProps.height;
|
|
64
57
|
}
|
|
65
|
-
const loader = (otherProps.loader ? otherProps.loader : exports.sitecoreLoader);
|
|
66
58
|
if (attrs) {
|
|
67
|
-
return react_1.default.createElement(image_1.default, Object.assign({ alt: ""
|
|
59
|
+
return react_1.default.createElement(image_1.default, Object.assign({ alt: "" }, imageProps));
|
|
68
60
|
}
|
|
69
61
|
return null; // we can't handle the truth
|
|
70
62
|
};
|
|
@@ -83,7 +75,4 @@ exports.NextImage.propTypes = {
|
|
|
83
75
|
mediaUrlPrefix: prop_types_1.default.instanceOf(RegExp),
|
|
84
76
|
imageParams: prop_types_1.default.objectOf(prop_types_1.default.oneOfType([prop_types_1.default.number.isRequired, prop_types_1.default.string.isRequired]).isRequired),
|
|
85
77
|
};
|
|
86
|
-
exports.NextImage.defaultProps = {
|
|
87
|
-
editable: true,
|
|
88
|
-
};
|
|
89
78
|
exports.NextImage.displayName = 'NextImage';
|
|
@@ -44,9 +44,9 @@ const router_1 = require("next/router");
|
|
|
44
44
|
const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
|
|
45
45
|
const prefetched = {};
|
|
46
46
|
const RichText = (props) => {
|
|
47
|
-
const { internalLinksSelector = 'a[href^="/"]' } = props, rest = __rest(props, ["internalLinksSelector"]);
|
|
47
|
+
const { internalLinksSelector = 'a[href^="/"]', prefetchLinks = true, editable = true } = props, rest = __rest(props, ["internalLinksSelector", "prefetchLinks", "editable"]);
|
|
48
48
|
const hasText = props.field && props.field.value;
|
|
49
|
-
const isEditing =
|
|
49
|
+
const isEditing = editable && props.field && props.field.editable;
|
|
50
50
|
const router = (0, router_1.useRouter)();
|
|
51
51
|
const richTextRef = (0, react_1.useRef)(null);
|
|
52
52
|
(0, react_1.useEffect)(() => {
|
|
@@ -54,12 +54,12 @@ const RichText = (props) => {
|
|
|
54
54
|
if (hasText && !isEditing) {
|
|
55
55
|
initializeLinks();
|
|
56
56
|
}
|
|
57
|
-
}, []);
|
|
57
|
+
}, [hasText]);
|
|
58
58
|
const routeHandler = (ev) => {
|
|
59
|
-
if (!ev.
|
|
59
|
+
if (!ev.currentTarget)
|
|
60
60
|
return;
|
|
61
61
|
ev.preventDefault();
|
|
62
|
-
const pathname = ev.
|
|
62
|
+
const pathname = ev.currentTarget.href;
|
|
63
63
|
router.push(pathname, pathname, { locale: false });
|
|
64
64
|
};
|
|
65
65
|
const initializeLinks = () => {
|
|
@@ -69,21 +69,17 @@ const RichText = (props) => {
|
|
|
69
69
|
if (!internalLinks || !internalLinks.length)
|
|
70
70
|
return;
|
|
71
71
|
internalLinks.forEach((link) => {
|
|
72
|
-
if (link.target
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
link.addEventListener('click', routeHandler, false);
|
|
72
|
+
if (link.target === '_blank')
|
|
73
|
+
return;
|
|
74
|
+
if (prefetchLinks && !prefetched[link.pathname]) {
|
|
75
|
+
router.prefetch(link.pathname, undefined, { locale: false });
|
|
76
|
+
prefetched[link.pathname] = true;
|
|
78
77
|
}
|
|
78
|
+
link.addEventListener('click', routeHandler, false);
|
|
79
79
|
});
|
|
80
80
|
};
|
|
81
81
|
return react_1.default.createElement(sitecore_jss_react_1.RichText, Object.assign({ ref: richTextRef }, rest));
|
|
82
82
|
};
|
|
83
83
|
exports.RichText = RichText;
|
|
84
84
|
exports.RichText.propTypes = Object.assign({ internalLinksSelector: prop_types_1.default.string }, sitecore_jss_react_1.RichTextPropTypes);
|
|
85
|
-
exports.RichText.defaultProps = {
|
|
86
|
-
tag: 'div',
|
|
87
|
-
editable: true,
|
|
88
|
-
};
|
|
89
85
|
exports.RichText.displayName = 'NextRichText';
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Context = void 0;
|
|
4
|
+
const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
|
|
5
|
+
/**
|
|
6
|
+
* Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
|
|
7
|
+
*/
|
|
8
|
+
class Context {
|
|
9
|
+
constructor(props) {
|
|
10
|
+
this.props = props;
|
|
11
|
+
/**
|
|
12
|
+
* Indicates whether the Context and SDK(s) have been initialized
|
|
13
|
+
*/
|
|
14
|
+
this.isInitialized = false;
|
|
15
|
+
/**
|
|
16
|
+
* Software Development Kits (SDKs) to be initialized
|
|
17
|
+
*/
|
|
18
|
+
this.sdks = {};
|
|
19
|
+
/**
|
|
20
|
+
* Promises for the SDKs
|
|
21
|
+
*/
|
|
22
|
+
this.sdkPromises = {};
|
|
23
|
+
this.sdkErrors = {};
|
|
24
|
+
/**
|
|
25
|
+
* Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
|
|
26
|
+
*
|
|
27
|
+
* @param {string} name SDK name
|
|
28
|
+
* @returns initialized SDK
|
|
29
|
+
*/
|
|
30
|
+
this.getSDK = (name) => {
|
|
31
|
+
if (!this.sdkPromises[name]) {
|
|
32
|
+
return Promise.reject(`Unknown SDK '${String(name)}'`);
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
return this.sdkPromises[name].then((result) => {
|
|
36
|
+
return ((this.sdkErrors[name] && Promise.reject(this.sdkErrors[name])) || Promise.resolve(result));
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
};
|
|
40
|
+
this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
|
|
41
|
+
this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
|
|
42
|
+
this.siteName = props.siteName;
|
|
43
|
+
this.pageState = sitecore_jss_react_1.LayoutServicePageState.Normal;
|
|
44
|
+
}
|
|
45
|
+
init(props = {}) {
|
|
46
|
+
// Context and SDKs are initialized only once
|
|
47
|
+
if (this.isInitialized)
|
|
48
|
+
return;
|
|
49
|
+
this.isInitialized = true;
|
|
50
|
+
if (props.siteName) {
|
|
51
|
+
this.siteName = props.siteName;
|
|
52
|
+
}
|
|
53
|
+
if (props.pageState) {
|
|
54
|
+
this.pageState = props.pageState;
|
|
55
|
+
}
|
|
56
|
+
// iterate over the SDKs and initialize them
|
|
57
|
+
for (const sdkName of Object.keys(this.props.sdks)) {
|
|
58
|
+
this.initSDK(sdkName);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Initializes the Software Development Kit (SDK)
|
|
63
|
+
*
|
|
64
|
+
* @param {T} name SDK name
|
|
65
|
+
* @returns {void}
|
|
66
|
+
*/
|
|
67
|
+
initSDK(name) {
|
|
68
|
+
this.sdkPromises[name] = new Promise((resolve) => {
|
|
69
|
+
this.props.sdks[name]
|
|
70
|
+
.init(this)
|
|
71
|
+
.then(() => {
|
|
72
|
+
this.sdks[name] = this.props.sdks[name].sdk;
|
|
73
|
+
resolve(this.sdks[name]);
|
|
74
|
+
})
|
|
75
|
+
.catch((e) => {
|
|
76
|
+
// if init rejects, we mark SDK as failed - so getSDK call would reject with a reason
|
|
77
|
+
this.sdkErrors[name] = e;
|
|
78
|
+
resolve(undefined);
|
|
79
|
+
});
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
exports.Context = Context;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.QUERY_PARAM_PROTECTION_BYPASS_VERCEL = exports.QUERY_PARAM_PROTECTION_BYPASS_SITECORE = exports.QUERY_PARAM_EDITING_SECRET = void 0;
|
|
4
|
+
exports.QUERY_PARAM_EDITING_SECRET = 'secret';
|
|
5
|
+
exports.QUERY_PARAM_PROTECTION_BYPASS_SITECORE = 'x-sitecore-protection-bypass';
|
|
6
|
+
exports.QUERY_PARAM_PROTECTION_BYPASS_VERCEL = 'x-vercel-protection-bypass';
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.EditingConfigMiddleware = void 0;
|
|
13
|
+
const constants_1 = require("./constants");
|
|
14
|
+
const utils_1 = require("../utils/utils");
|
|
15
|
+
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
16
|
+
/**
|
|
17
|
+
* Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
|
|
18
|
+
* provides configuration information to determine feature compatibility on Pages side.
|
|
19
|
+
*/
|
|
20
|
+
class EditingConfigMiddleware {
|
|
21
|
+
/**
|
|
22
|
+
* @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
|
|
23
|
+
*/
|
|
24
|
+
constructor(config) {
|
|
25
|
+
this.config = config;
|
|
26
|
+
this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
27
|
+
const secret = _req.query[constants_1.QUERY_PARAM_EDITING_SECRET];
|
|
28
|
+
if (secret !== (0, utils_1.getJssEditingSecret)()) {
|
|
29
|
+
sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
|
|
30
|
+
return res.status(401).json({ message: 'Missing or invalid editing secret' });
|
|
31
|
+
}
|
|
32
|
+
const components = Array.isArray(this.config.components)
|
|
33
|
+
? this.config.components
|
|
34
|
+
: Array.from(this.config.components.keys());
|
|
35
|
+
return res.status(200).json({
|
|
36
|
+
components,
|
|
37
|
+
packages: this.config.metadata.packages,
|
|
38
|
+
});
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Gets the Next.js API route handler
|
|
43
|
+
* @returns middleware handler
|
|
44
|
+
*/
|
|
45
|
+
getHandler() {
|
|
46
|
+
return this.handler;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
exports.EditingConfigMiddleware = EditingConfigMiddleware;
|
|
@@ -12,8 +12,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
12
12
|
exports.EditingDataMiddleware = void 0;
|
|
13
13
|
const editing_data_cache_1 = require("./editing-data-cache");
|
|
14
14
|
const editing_data_1 = require("./editing-data");
|
|
15
|
-
const
|
|
16
|
-
const utils_1 = require("../utils");
|
|
15
|
+
const constants_1 = require("./constants");
|
|
16
|
+
const utils_1 = require("../utils/utils");
|
|
17
17
|
/**
|
|
18
18
|
* Middleware / handler for use in the editing data Next.js API dynamic route (e.g. '/api/editing/data/[key]')
|
|
19
19
|
* which is required for Sitecore editing support.
|
|
@@ -26,7 +26,7 @@ class EditingDataMiddleware {
|
|
|
26
26
|
var _a, _b;
|
|
27
27
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
28
28
|
const { method, query, body } = req;
|
|
29
|
-
const secret = query[
|
|
29
|
+
const secret = query[constants_1.QUERY_PARAM_EDITING_SECRET];
|
|
30
30
|
const key = query[this.queryParamKey];
|
|
31
31
|
// Validate secret
|
|
32
32
|
if (secret !== (0, utils_1.getJssEditingSecret)()) {
|
|
@@ -9,11 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.generateKey =
|
|
12
|
+
exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.generateKey = void 0;
|
|
13
|
+
const constants_1 = require("./constants");
|
|
13
14
|
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
14
15
|
const editing_data_cache_1 = require("./editing-data-cache");
|
|
15
|
-
const utils_1 = require("../utils");
|
|
16
|
-
exports.QUERY_PARAM_EDITING_SECRET = 'secret';
|
|
16
|
+
const utils_1 = require("../utils/utils");
|
|
17
17
|
/**
|
|
18
18
|
* Unique key generator.
|
|
19
19
|
* Need more than just the item GUID since requests are made "live" during editing in EE.
|
|
@@ -98,13 +98,14 @@ class ServerlessEditingDataService {
|
|
|
98
98
|
* @param {string} serverUrl The server url to use for subsequent data API requests
|
|
99
99
|
* @returns {Promise} The {@link EditingPreviewData} containing the generated key and serverUrl to use for retrieval
|
|
100
100
|
*/
|
|
101
|
-
setEditingData(data, serverUrl) {
|
|
101
|
+
setEditingData(data, serverUrl, params) {
|
|
102
102
|
return __awaiter(this, void 0, void 0, function* () {
|
|
103
103
|
const key = this.generateKey(data);
|
|
104
|
-
const url = this.getUrl(serverUrl, key);
|
|
104
|
+
const url = this.getUrl(serverUrl, key, params);
|
|
105
105
|
const previewData = {
|
|
106
106
|
key,
|
|
107
107
|
serverUrl,
|
|
108
|
+
params,
|
|
108
109
|
};
|
|
109
110
|
sitecore_jss_1.debug.editing('storing editing data for %o: %o', previewData, data);
|
|
110
111
|
return this.dataFetcher.put(url, data).then(() => {
|
|
@@ -123,20 +124,27 @@ class ServerlessEditingDataService {
|
|
|
123
124
|
if (!(editingPreviewData === null || editingPreviewData === void 0 ? void 0 : editingPreviewData.serverUrl)) {
|
|
124
125
|
return undefined;
|
|
125
126
|
}
|
|
126
|
-
const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key);
|
|
127
|
+
const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key, editingPreviewData.params);
|
|
127
128
|
sitecore_jss_1.debug.editing('retrieving editing data for %o', previewData);
|
|
128
129
|
return this.dataFetcher.get(url).then((response) => {
|
|
129
130
|
return response.data;
|
|
130
131
|
});
|
|
131
132
|
});
|
|
132
133
|
}
|
|
133
|
-
getUrl(serverUrl, key) {
|
|
134
|
+
getUrl(serverUrl, key, params) {
|
|
134
135
|
var _a;
|
|
135
136
|
// Example URL format:
|
|
136
137
|
// http://localhost:3000/api/editing/data/52961eea-bafd-5287-a532-a72e36bd8a36-qkb4e3fv5x?secret=1234secret
|
|
137
138
|
const apiRoute = (_a = this.apiRoute) === null || _a === void 0 ? void 0 : _a.replace('[key]', key);
|
|
138
139
|
const url = new URL(apiRoute, serverUrl);
|
|
139
|
-
url.searchParams.append(
|
|
140
|
+
url.searchParams.append(constants_1.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
|
|
141
|
+
if (params) {
|
|
142
|
+
for (const key in params) {
|
|
143
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
144
|
+
url.searchParams.append(key, params[key]);
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
140
148
|
return url.toString();
|
|
141
149
|
}
|
|
142
150
|
}
|
|
@@ -15,20 +15,24 @@ const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
|
15
15
|
const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
|
|
16
16
|
const node_html_parser_1 = require("node-html-parser");
|
|
17
17
|
const editing_data_service_1 = require("./editing-data-service");
|
|
18
|
-
const
|
|
18
|
+
const constants_2 = require("./constants");
|
|
19
|
+
const utils_1 = require("../utils/utils");
|
|
20
|
+
const render_middleware_1 = require("./render-middleware");
|
|
19
21
|
/**
|
|
20
22
|
* Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
|
|
21
23
|
* which is required for Sitecore editing support.
|
|
22
24
|
*/
|
|
23
|
-
class EditingRenderMiddleware {
|
|
25
|
+
class EditingRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
|
|
24
26
|
/**
|
|
25
27
|
* @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
|
|
26
28
|
*/
|
|
27
29
|
constructor(config) {
|
|
28
30
|
var _a, _b, _c, _d;
|
|
31
|
+
super();
|
|
29
32
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
30
33
|
var _e, _f;
|
|
31
34
|
const { method, query, body, headers } = req;
|
|
35
|
+
const startTimestamp = Date.now();
|
|
32
36
|
sitecore_jss_1.debug.editing('editing render middleware start: %o', {
|
|
33
37
|
method,
|
|
34
38
|
query,
|
|
@@ -43,7 +47,7 @@ class EditingRenderMiddleware {
|
|
|
43
47
|
});
|
|
44
48
|
}
|
|
45
49
|
// Validate secret
|
|
46
|
-
const secret = (_e = query[
|
|
50
|
+
const secret = (_e = query[constants_2.QUERY_PARAM_EDITING_SECRET]) !== null && _e !== void 0 ? _e : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
|
|
47
51
|
if (secret !== (0, utils_1.getJssEditingSecret)()) {
|
|
48
52
|
sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
|
|
49
53
|
return res.status(401).json({
|
|
@@ -55,21 +59,28 @@ class EditingRenderMiddleware {
|
|
|
55
59
|
const editingData = extractEditingData(req);
|
|
56
60
|
// Resolve server URL
|
|
57
61
|
const serverUrl = this.resolveServerUrl(req);
|
|
62
|
+
// Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
|
|
63
|
+
const params = this.getQueryParamsForPropagation(query);
|
|
58
64
|
// Stash for use later on (i.e. within getStatic/ServerSideProps).
|
|
59
65
|
// Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
|
|
60
66
|
// https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
|
|
61
|
-
const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
|
|
67
|
+
const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
|
|
62
68
|
// Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
|
|
63
69
|
res.setPreviewData(previewData);
|
|
64
70
|
// Grab the Next.js preview cookies to send on to the render request
|
|
65
71
|
const cookies = res.getHeader('Set-Cookie');
|
|
66
|
-
// Make actual render request for page route, passing on preview cookies.
|
|
72
|
+
// Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
|
|
67
73
|
// Note timestamp effectively disables caching the request in Axios (no amount of cache headers seemed to do it)
|
|
68
|
-
const requestUrl = this.resolvePageUrl(serverUrl, editingData.path);
|
|
69
74
|
sitecore_jss_1.debug.editing('fetching page route for %s', editingData.path);
|
|
70
|
-
const
|
|
75
|
+
const requestUrl = new URL(this.resolvePageUrl(serverUrl, editingData.path));
|
|
76
|
+
for (const key in params) {
|
|
77
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
78
|
+
requestUrl.searchParams.append(key, params[key]);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
requestUrl.searchParams.append('timestamp', Date.now().toString());
|
|
71
82
|
const pageRes = yield this.dataFetcher
|
|
72
|
-
.get(
|
|
83
|
+
.get(requestUrl.toString(), {
|
|
73
84
|
headers: {
|
|
74
85
|
Cookie: cookies.join(';'),
|
|
75
86
|
},
|
|
@@ -84,7 +95,7 @@ class EditingRenderMiddleware {
|
|
|
84
95
|
});
|
|
85
96
|
let html = pageRes.data;
|
|
86
97
|
if (!html || html.length === 0) {
|
|
87
|
-
throw new Error(`Failed to render html for ${
|
|
98
|
+
throw new Error(`Failed to render html for ${editingData.path}`);
|
|
88
99
|
}
|
|
89
100
|
// replace phkey attribute with key attribute so that newly added renderings
|
|
90
101
|
// show correct placeholders, so save and refresh won't be needed after adding each rendering
|
|
@@ -100,11 +111,14 @@ class EditingRenderMiddleware {
|
|
|
100
111
|
// Handle component rendering. Extract component markup only
|
|
101
112
|
html = (_f = (0, node_html_parser_1.parse)(html).getElementById(layout_1.EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
|
|
102
113
|
if (!html)
|
|
103
|
-
throw new Error(`Failed to render component for ${
|
|
114
|
+
throw new Error(`Failed to render component for ${editingData.path}`);
|
|
104
115
|
}
|
|
105
116
|
const body = { html };
|
|
106
117
|
// Return expected JSON result
|
|
107
|
-
sitecore_jss_1.debug.editing('editing render middleware end: %o',
|
|
118
|
+
sitecore_jss_1.debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
119
|
+
status: 200,
|
|
120
|
+
body,
|
|
121
|
+
});
|
|
108
122
|
res.status(200).json(body);
|
|
109
123
|
}
|
|
110
124
|
catch (err) {
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.FEAASRenderMiddleware = void 0;
|
|
13
|
+
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
14
|
+
const constants_1 = require("./constants");
|
|
15
|
+
const utils_1 = require("../utils/utils");
|
|
16
|
+
const render_middleware_1 = require("./render-middleware");
|
|
17
|
+
/**
|
|
18
|
+
* Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
|
|
19
|
+
* which is required for Sitecore editing support.
|
|
20
|
+
*/
|
|
21
|
+
class FEAASRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
|
|
22
|
+
/**
|
|
23
|
+
* @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
|
|
24
|
+
*/
|
|
25
|
+
constructor(config) {
|
|
26
|
+
var _a;
|
|
27
|
+
super();
|
|
28
|
+
this.config = config;
|
|
29
|
+
this.defaultPageUrl = '/feaas/render';
|
|
30
|
+
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
31
|
+
const { method, query, headers } = req;
|
|
32
|
+
const startTimestamp = Date.now();
|
|
33
|
+
sitecore_jss_1.debug.editing('feaas render middleware start: %o', {
|
|
34
|
+
method,
|
|
35
|
+
query,
|
|
36
|
+
headers,
|
|
37
|
+
});
|
|
38
|
+
if (method !== 'GET') {
|
|
39
|
+
sitecore_jss_1.debug.editing('invalid method - sent %s expected GET', method);
|
|
40
|
+
res.setHeader('Allow', 'GET');
|
|
41
|
+
return res.status(405).send(`<html><body>Invalid request method '${method}'</body></html>`);
|
|
42
|
+
}
|
|
43
|
+
// Validate secret
|
|
44
|
+
const secret = query[constants_1.QUERY_PARAM_EDITING_SECRET];
|
|
45
|
+
if (secret !== (0, utils_1.getJssEditingSecret)()) {
|
|
46
|
+
sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
|
|
47
|
+
return res.status(401).send('<html><body>Missing or invalid secret</body></html>');
|
|
48
|
+
}
|
|
49
|
+
try {
|
|
50
|
+
// Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
|
|
51
|
+
const params = this.getQueryParamsForPropagation(query);
|
|
52
|
+
// Enable Next.js Preview Mode
|
|
53
|
+
res.setPreviewData({});
|
|
54
|
+
const queryParams = new URLSearchParams();
|
|
55
|
+
for (const key in params) {
|
|
56
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
57
|
+
queryParams.append(key, params[key]);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
// Pass "feaasSrc" in case a FEAASComponent is being requested
|
|
61
|
+
if (query.feaasSrc) {
|
|
62
|
+
queryParams.append('feaasSrc', query.feaasSrc);
|
|
63
|
+
}
|
|
64
|
+
const redirectUrl = this.pageUrl + (queryParams.toString() ? `?${queryParams.toString()}` : '');
|
|
65
|
+
sitecore_jss_1.debug.editing('redirecting to page route %s', redirectUrl);
|
|
66
|
+
sitecore_jss_1.debug.editing('feaas render middleware end in %dms', Date.now() - startTimestamp);
|
|
67
|
+
res.redirect(redirectUrl);
|
|
68
|
+
}
|
|
69
|
+
catch (err) {
|
|
70
|
+
const error = err;
|
|
71
|
+
console.info(
|
|
72
|
+
// eslint-disable-next-line quotes
|
|
73
|
+
"Hint: for non-standard server or Next.js route configurations, you may need to override the 'pageUrl' available on the 'FEAASRenderMiddleware' config.");
|
|
74
|
+
res.status(500).send(`<html><body>${error}</body></html>`);
|
|
75
|
+
}
|
|
76
|
+
});
|
|
77
|
+
this.pageUrl = (_a = config === null || config === void 0 ? void 0 : config.pageUrl) !== null && _a !== void 0 ? _a : this.defaultPageUrl;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Gets the Next.js API route handler
|
|
81
|
+
* @returns route handler
|
|
82
|
+
*/
|
|
83
|
+
getHandler() {
|
|
84
|
+
return this.handler;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
exports.FEAASRenderMiddleware = FEAASRenderMiddleware;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = void 0;
|
|
3
|
+
exports.EditingConfigMiddleware = exports.FEAASRenderMiddleware = exports.VercelEditingDataCache = exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = void 0;
|
|
4
4
|
var editing_data_cache_1 = require("./editing-data-cache");
|
|
5
5
|
Object.defineProperty(exports, "EditingDataDiskCache", { enumerable: true, get: function () { return editing_data_cache_1.EditingDataDiskCache; } });
|
|
6
6
|
var editing_data_middleware_1 = require("./editing-data-middleware");
|
|
@@ -11,3 +11,9 @@ var editing_data_service_1 = require("./editing-data-service");
|
|
|
11
11
|
Object.defineProperty(exports, "BasicEditingDataService", { enumerable: true, get: function () { return editing_data_service_1.BasicEditingDataService; } });
|
|
12
12
|
Object.defineProperty(exports, "ServerlessEditingDataService", { enumerable: true, get: function () { return editing_data_service_1.ServerlessEditingDataService; } });
|
|
13
13
|
Object.defineProperty(exports, "editingDataService", { enumerable: true, get: function () { return editing_data_service_1.editingDataService; } });
|
|
14
|
+
var vercel_editing_data_cache_1 = require("./vercel-editing-data-cache");
|
|
15
|
+
Object.defineProperty(exports, "VercelEditingDataCache", { enumerable: true, get: function () { return vercel_editing_data_cache_1.VercelEditingDataCache; } });
|
|
16
|
+
var feaas_render_middleware_1 = require("./feaas-render-middleware");
|
|
17
|
+
Object.defineProperty(exports, "FEAASRenderMiddleware", { enumerable: true, get: function () { return feaas_render_middleware_1.FEAASRenderMiddleware; } });
|
|
18
|
+
var editing_config_middleware_1 = require("./editing-config-middleware");
|
|
19
|
+
Object.defineProperty(exports, "EditingConfigMiddleware", { enumerable: true, get: function () { return editing_config_middleware_1.EditingConfigMiddleware; } });
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RenderMiddlewareBase = void 0;
|
|
4
|
+
const constants_1 = require("./constants");
|
|
5
|
+
/**
|
|
6
|
+
* Base class for middleware that handles pages and components rendering in Sitecore Editors.
|
|
7
|
+
*/
|
|
8
|
+
class RenderMiddlewareBase {
|
|
9
|
+
constructor() {
|
|
10
|
+
/**
|
|
11
|
+
* Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
|
|
12
|
+
* @param {Object} query Object of query parameters from incoming URL
|
|
13
|
+
* @returns Object of approved query parameters
|
|
14
|
+
*/
|
|
15
|
+
this.getQueryParamsForPropagation = (query) => {
|
|
16
|
+
const params = {};
|
|
17
|
+
if (query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
|
|
18
|
+
params[constants_1.QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
|
|
19
|
+
}
|
|
20
|
+
if (query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
|
|
21
|
+
params[constants_1.QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
|
|
22
|
+
}
|
|
23
|
+
return params;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
exports.RenderMiddlewareBase = RenderMiddlewareBase;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.VercelEditingDataCache = void 0;
|
|
4
|
+
const kv_1 = require("@vercel/kv");
|
|
5
|
+
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
6
|
+
/**
|
|
7
|
+
* Implementation of editing cache for Vercel deployments
|
|
8
|
+
* Uses Vercel KV database and client to store data
|
|
9
|
+
* Set TTL for cache data in constructor (default: 60 seconds)
|
|
10
|
+
*/
|
|
11
|
+
class VercelEditingDataCache {
|
|
12
|
+
/**
|
|
13
|
+
* @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
|
|
14
|
+
* @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
|
|
15
|
+
*/
|
|
16
|
+
constructor(redisUrl, redisToken) {
|
|
17
|
+
this.defaultTtl = 120;
|
|
18
|
+
if (!redisUrl || !redisToken) {
|
|
19
|
+
throw Error('API URL or token are missing, ensure you have set the KV or Upstash storage correctly.');
|
|
20
|
+
}
|
|
21
|
+
this.redisCache = (0, kv_1.createClient)({
|
|
22
|
+
url: redisUrl,
|
|
23
|
+
token: redisToken,
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
set(key, editingData) {
|
|
27
|
+
sitecore_jss_1.debug.editing(`Putting editing data for ${key} into redis storage...`);
|
|
28
|
+
return new Promise((resolve, reject) => {
|
|
29
|
+
this.redisCache
|
|
30
|
+
.set(key, JSON.stringify(editingData), { ex: this.defaultTtl })
|
|
31
|
+
.then(() => resolve())
|
|
32
|
+
.catch((err) => reject(err));
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
get(key) {
|
|
36
|
+
sitecore_jss_1.debug.editing(`Getting editing data for ${key} from redis storage...`);
|
|
37
|
+
return new Promise((resolve, reject) => {
|
|
38
|
+
this.redisCache
|
|
39
|
+
.get(key)
|
|
40
|
+
.then((entry) => {
|
|
41
|
+
const result = (entry || undefined);
|
|
42
|
+
this.redisCache.expire(key, 0).then(() => resolve(result));
|
|
43
|
+
})
|
|
44
|
+
.catch((err) => reject(err));
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
exports.VercelEditingDataCache = VercelEditingDataCache;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getEdgeProxyContentUrl = exports.GraphQLRequestClient = exports.DefaultRetryStrategy = void 0;
|
|
4
|
+
var graphql_1 = require("@sitecore-jss/sitecore-jss/graphql");
|
|
5
|
+
Object.defineProperty(exports, "DefaultRetryStrategy", { enumerable: true, get: function () { return graphql_1.DefaultRetryStrategy; } });
|
|
6
|
+
Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_1.GraphQLRequestClient; } });
|
|
7
|
+
Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return graphql_1.getEdgeProxyContentUrl; } });
|