@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.6 → 21.7.0-canary.61
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/context.d.ts +1 -0
- package/context.js +1 -0
- package/dist/cjs/components/NextImage.js +2 -10
- package/dist/cjs/components/RichText.js +2 -2
- package/dist/cjs/context/context.js +83 -0
- package/dist/cjs/context/index.js +5 -0
- package/dist/cjs/editing/editing-config-middleware.js +49 -0
- package/dist/cjs/editing/editing-render-middleware.js +3 -16
- package/dist/cjs/editing/feaas-render-middleware.js +87 -0
- package/dist/cjs/editing/index.js +5 -1
- package/dist/cjs/editing/render-middleware.js +27 -0
- package/dist/cjs/graphql/index.js +2 -1
- package/dist/cjs/index.js +6 -3
- package/dist/cjs/middleware/personalize-middleware.js +33 -32
- package/dist/cjs/middleware/redirects-middleware.js +24 -9
- package/dist/cjs/revalidate/index.js +5 -0
- package/dist/cjs/revalidate/revalidate-middleware.js +216 -0
- package/dist/cjs/utils/utils.js +6 -18
- package/dist/esm/components/NextImage.js +1 -8
- package/dist/esm/components/RichText.js +2 -2
- package/dist/esm/context/context.js +79 -0
- package/dist/esm/context/index.js +1 -0
- package/dist/esm/editing/editing-config-middleware.js +45 -0
- package/dist/esm/editing/editing-render-middleware.js +4 -17
- package/dist/esm/editing/feaas-render-middleware.js +83 -0
- package/dist/esm/editing/index.js +2 -0
- package/dist/esm/editing/render-middleware.js +23 -0
- package/dist/esm/graphql/index.js +1 -1
- package/dist/esm/index.js +4 -3
- package/dist/esm/middleware/personalize-middleware.js +34 -33
- package/dist/esm/middleware/redirects-middleware.js +24 -9
- package/dist/esm/revalidate/index.js +1 -0
- package/dist/esm/revalidate/revalidate-middleware.js +212 -0
- package/dist/esm/utils/utils.js +6 -15
- package/package.json +13 -13
- package/revalidate.d.ts +1 -0
- package/revalidate.js +1 -0
- package/types/components/NextImage.d.ts +1 -2
- package/types/context/context.d.ts +116 -0
- package/types/context/index.d.ts +1 -0
- package/types/editing/editing-config-middleware.d.ts +29 -0
- package/types/editing/editing-render-middleware.d.ts +2 -11
- package/types/editing/feaas-render-middleware.d.ts +32 -0
- package/types/editing/index.d.ts +2 -0
- package/types/editing/render-middleware.d.ts +15 -0
- package/types/graphql/index.d.ts +1 -1
- package/types/index.d.ts +4 -3
- package/types/middleware/personalize-middleware.d.ts +20 -15
- package/types/revalidate/index.d.ts +1 -0
- package/types/revalidate/revalidate-middleware.d.ts +115 -0
- package/types/utils/utils.d.ts +1 -0
package/context.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './types/context/index';
|
package/context.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require('./dist/cjs/context/index');
|
|
@@ -14,19 +14,12 @@ 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
24
|
var { editable, 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,
|
|
@@ -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
|
};
|
|
@@ -56,10 +56,10 @@ const RichText = (props) => {
|
|
|
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 = () => {
|
|
@@ -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,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
|
+
res.status(401).end('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;
|
|
@@ -17,31 +17,18 @@ const node_html_parser_1 = require("node-html-parser");
|
|
|
17
17
|
const editing_data_service_1 = require("./editing-data-service");
|
|
18
18
|
const constants_2 = require("./constants");
|
|
19
19
|
const utils_1 = require("../utils/utils");
|
|
20
|
+
const render_middleware_1 = require("./render-middleware");
|
|
20
21
|
/**
|
|
21
22
|
* Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
|
|
22
23
|
* which is required for Sitecore editing support.
|
|
23
24
|
*/
|
|
24
|
-
class EditingRenderMiddleware {
|
|
25
|
+
class EditingRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
|
|
25
26
|
/**
|
|
26
27
|
* @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
|
|
27
28
|
*/
|
|
28
29
|
constructor(config) {
|
|
29
30
|
var _a, _b, _c, _d;
|
|
30
|
-
|
|
31
|
-
* Gets query parameters that should be passed along to subsequent requests
|
|
32
|
-
* @param query Object of query parameters from incoming URL
|
|
33
|
-
* @returns Object of approved query parameters
|
|
34
|
-
*/
|
|
35
|
-
this.getQueryParamsForPropagation = (query) => {
|
|
36
|
-
const params = {};
|
|
37
|
-
if (query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
|
|
38
|
-
params[constants_2.QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
|
|
39
|
-
}
|
|
40
|
-
if (query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
|
|
41
|
-
params[constants_2.QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[constants_2.QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
|
|
42
|
-
}
|
|
43
|
-
return params;
|
|
44
|
-
};
|
|
31
|
+
super();
|
|
45
32
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
46
33
|
var _e, _f;
|
|
47
34
|
const { method, query, body, headers } = req;
|
|
@@ -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.VercelEditingDataCache = 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");
|
|
@@ -13,3 +13,7 @@ Object.defineProperty(exports, "ServerlessEditingDataService", { enumerable: tru
|
|
|
13
13
|
Object.defineProperty(exports, "editingDataService", { enumerable: true, get: function () { return editing_data_service_1.editingDataService; } });
|
|
14
14
|
var vercel_editing_data_cache_1 = require("./vercel-editing-data-cache");
|
|
15
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;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getEdgeProxyContentUrl = exports.GraphQLRequestClient = void 0;
|
|
3
|
+
exports.getEdgeProxyContentUrl = exports.GraphQLRequestClient = exports.DefaultRetryStrategy = void 0;
|
|
4
4
|
var graphql_1 = require("@sitecore-jss/sitecore-jss/graphql");
|
|
5
|
+
Object.defineProperty(exports, "DefaultRetryStrategy", { enumerable: true, get: function () { return graphql_1.DefaultRetryStrategy; } });
|
|
5
6
|
Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_1.GraphQLRequestClient; } });
|
|
6
7
|
Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return graphql_1.getEdgeProxyContentUrl; } });
|
package/dist/cjs/index.js
CHANGED
|
@@ -23,8 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
23
23
|
return result;
|
|
24
24
|
};
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
-
exports.NextImage = exports.EditingComponentPlaceholder = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.
|
|
27
|
-
exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = void 0;
|
|
26
|
+
exports.NextImage = exports.EditingComponentPlaceholder = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.getContentStylesheetLink = exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.tryParseEnvValue = exports.resolveUrl = exports.resetEditorChromes = exports.isEditorActive = exports.getPublicUrl = exports.handleEditorFastRefresh = exports.GraphQLRequestClient = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.AxiosDataFetcher = exports.constants = void 0;
|
|
27
|
+
exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.getComponentLibraryStylesheetLinks = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.Context = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = void 0;
|
|
28
28
|
var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
29
29
|
Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
|
|
30
30
|
Object.defineProperty(exports, "AxiosDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.AxiosDataFetcher; } });
|
|
@@ -65,6 +65,7 @@ Object.defineProperty(exports, "getFieldValue", { enumerable: true, get: functio
|
|
|
65
65
|
Object.defineProperty(exports, "RenderingType", { enumerable: true, get: function () { return layout_1.RenderingType; } });
|
|
66
66
|
Object.defineProperty(exports, "EDITING_COMPONENT_PLACEHOLDER", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_PLACEHOLDER; } });
|
|
67
67
|
Object.defineProperty(exports, "EDITING_COMPONENT_ID", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_ID; } });
|
|
68
|
+
Object.defineProperty(exports, "getContentStylesheetLink", { enumerable: true, get: function () { return layout_1.getContentStylesheetLink; } });
|
|
68
69
|
var media_1 = require("@sitecore-jss/sitecore-jss/media");
|
|
69
70
|
Object.defineProperty(exports, "mediaApi", { enumerable: true, get: function () { return media_1.mediaApi; } });
|
|
70
71
|
var tracking_1 = require("@sitecore-jss/sitecore-jss/tracking");
|
|
@@ -78,7 +79,6 @@ Object.defineProperty(exports, "getPersonalizedRewrite", { enumerable: true, get
|
|
|
78
79
|
Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true, get: function () { return personalize_1.getPersonalizedRewriteData; } });
|
|
79
80
|
Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return personalize_1.normalizePersonalizedRewrite; } });
|
|
80
81
|
Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return personalize_1.CdpHelper; } });
|
|
81
|
-
Object.defineProperty(exports, "PosResolver", { enumerable: true, get: function () { return personalize_1.PosResolver; } });
|
|
82
82
|
var component_props_service_1 = require("./services/component-props-service");
|
|
83
83
|
Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
|
|
84
84
|
var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
|
|
@@ -116,6 +116,8 @@ const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
|
|
|
116
116
|
exports.BYOCWrapper = BYOCWrapper;
|
|
117
117
|
var ComponentBuilder_1 = require("./ComponentBuilder");
|
|
118
118
|
Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
|
|
119
|
+
var context_1 = require("./context");
|
|
120
|
+
Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
|
|
119
121
|
var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
|
|
120
122
|
Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return sitecore_jss_react_1.Image; } });
|
|
121
123
|
Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return sitecore_jss_react_1.Text; } });
|
|
@@ -125,6 +127,7 @@ Object.defineProperty(exports, "FEaaSComponent", { enumerable: true, get: functi
|
|
|
125
127
|
Object.defineProperty(exports, "fetchFEaaSComponentServerProps", { enumerable: true, get: function () { return sitecore_jss_react_1.fetchFEaaSComponentServerProps; } });
|
|
126
128
|
Object.defineProperty(exports, "BYOCComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCComponent; } });
|
|
127
129
|
Object.defineProperty(exports, "getFEAASLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getFEAASLibraryStylesheetLinks; } });
|
|
130
|
+
Object.defineProperty(exports, "getComponentLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getComponentLibraryStylesheetLinks; } });
|
|
128
131
|
Object.defineProperty(exports, "File", { enumerable: true, get: function () { return sitecore_jss_react_1.File; } });
|
|
129
132
|
Object.defineProperty(exports, "VisitorIdentification", { enumerable: true, get: function () { return sitecore_jss_react_1.VisitorIdentification; } });
|
|
130
133
|
Object.defineProperty(exports, "SitecoreContext", { enumerable: true, get: function () { return sitecore_jss_react_1.SitecoreContext; } });
|
|
@@ -14,7 +14,7 @@ const server_1 = require("next/server");
|
|
|
14
14
|
const personalize_1 = require("@sitecore-jss/sitecore-jss/personalize");
|
|
15
15
|
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
16
16
|
const middleware_1 = require("./middleware");
|
|
17
|
-
const
|
|
17
|
+
const server_2 = require("@sitecore-cloudsdk/personalize/server");
|
|
18
18
|
/**
|
|
19
19
|
* Middleware / handler to support Sitecore Personalize
|
|
20
20
|
*/
|
|
@@ -26,7 +26,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
26
26
|
super(config);
|
|
27
27
|
this.config = config;
|
|
28
28
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
29
|
-
var _a;
|
|
30
29
|
const pathname = req.nextUrl.pathname;
|
|
31
30
|
const language = this.getLanguage(req);
|
|
32
31
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
@@ -62,30 +61,20 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
62
61
|
sitecore_jss_1.debug.personalize('skipped (no personalization configured)');
|
|
63
62
|
return response;
|
|
64
63
|
}
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
}
|
|
71
|
-
catch (error) {
|
|
72
|
-
sitecore_jss_1.debug.personalize('skipped (browser id generation failed)');
|
|
73
|
-
throw error;
|
|
74
|
-
}
|
|
64
|
+
yield this.initPersonalizeServer({
|
|
65
|
+
hostname,
|
|
66
|
+
siteName: site.name,
|
|
67
|
+
request: req,
|
|
68
|
+
response,
|
|
69
|
+
});
|
|
75
70
|
const params = this.getExperienceParams(req);
|
|
76
|
-
sitecore_jss_1.debug.personalize('executing experience for %s %
|
|
77
|
-
const personalizationData = {
|
|
78
|
-
channel: this.config.cdpConfig.channel || 'WEB',
|
|
79
|
-
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USA',
|
|
80
|
-
friendlyId: personalizeInfo.contentId,
|
|
81
|
-
params,
|
|
82
|
-
language,
|
|
83
|
-
};
|
|
71
|
+
sitecore_jss_1.debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
|
|
84
72
|
let variantId;
|
|
85
|
-
// Execute targeted experience in
|
|
73
|
+
// Execute targeted experience in Personalize SDK
|
|
86
74
|
// eslint-disable-next-line no-useless-catch
|
|
87
75
|
try {
|
|
88
|
-
|
|
76
|
+
const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
|
|
77
|
+
variantId = personalization.variantId;
|
|
89
78
|
}
|
|
90
79
|
catch (error) {
|
|
91
80
|
throw error;
|
|
@@ -132,17 +121,29 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
132
121
|
}
|
|
133
122
|
});
|
|
134
123
|
}
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
:
|
|
142
|
-
|
|
143
|
-
|
|
124
|
+
initPersonalizeServer({ hostname, siteName, request, response, }) {
|
|
125
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
126
|
+
yield (0, server_2.init)({
|
|
127
|
+
sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
|
|
128
|
+
sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
|
|
129
|
+
siteName,
|
|
130
|
+
cookieDomain: hostname,
|
|
131
|
+
enableServerCookie: true,
|
|
132
|
+
}, request, response);
|
|
133
|
+
});
|
|
134
|
+
}
|
|
135
|
+
personalize({ params, personalizeInfo, language, timeout, }, request) {
|
|
136
|
+
var _a;
|
|
137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
const personalizationData = {
|
|
139
|
+
channel: this.config.cdpConfig.channel || 'WEB',
|
|
140
|
+
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
|
|
141
|
+
friendlyId: personalizeInfo.contentId,
|
|
142
|
+
params,
|
|
143
|
+
language,
|
|
144
|
+
};
|
|
145
|
+
return (yield (0, server_2.personalize)(personalizationData, request, timeout));
|
|
144
146
|
});
|
|
145
|
-
return engageServer;
|
|
146
147
|
}
|
|
147
148
|
getExperienceParams(req) {
|
|
148
149
|
const utm = {
|
|
@@ -18,7 +18,8 @@ const server_1 = require("next/server");
|
|
|
18
18
|
const site_1 = require("@sitecore-jss/sitecore-jss/site");
|
|
19
19
|
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
20
20
|
const middleware_1 = require("./middleware");
|
|
21
|
-
const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, '
|
|
21
|
+
const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
|
|
22
|
+
const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
|
|
22
23
|
/**
|
|
23
24
|
* Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
|
|
24
25
|
* compares with current url and redirects to target url
|
|
@@ -58,25 +59,35 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
|
|
|
58
59
|
return res || server_1.NextResponse.next();
|
|
59
60
|
}
|
|
60
61
|
// Find context site language and replace token
|
|
61
|
-
if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target)
|
|
62
|
+
if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
|
|
63
|
+
!(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
|
|
64
|
+
existsRedirect.target.includes(hostname))) {
|
|
62
65
|
existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
|
|
63
66
|
}
|
|
64
67
|
const url = req.nextUrl.clone();
|
|
65
|
-
|
|
66
|
-
if (absoluteUrlRegex.test(existsRedirect.target)) {
|
|
68
|
+
if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
|
|
67
69
|
url.href = existsRedirect.target;
|
|
68
70
|
url.locale = req.nextUrl.locale;
|
|
69
71
|
}
|
|
70
72
|
else {
|
|
73
|
+
const source = `${url.pathname}${url.search}`;
|
|
71
74
|
url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
|
|
72
75
|
const urlFirstPart = existsRedirect.target.split('/')[1];
|
|
73
76
|
if (this.locales.includes(urlFirstPart)) {
|
|
74
77
|
url.locale = urlFirstPart;
|
|
75
78
|
existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
|
|
76
79
|
}
|
|
77
|
-
|
|
80
|
+
const target = source
|
|
78
81
|
.replace((0, regex_parser_1.default)(existsRedirect.pattern), existsRedirect.target)
|
|
79
|
-
.replace(/^\/\//, '/')
|
|
82
|
+
.replace(/^\/\//, '/')
|
|
83
|
+
.split('?');
|
|
84
|
+
url.pathname = target[0];
|
|
85
|
+
if (target[1]) {
|
|
86
|
+
const newParams = new URLSearchParams(target[1]);
|
|
87
|
+
for (const [key, val] of newParams.entries()) {
|
|
88
|
+
url.searchParams.append(key, val);
|
|
89
|
+
}
|
|
90
|
+
}
|
|
80
91
|
}
|
|
81
92
|
const redirectUrl = decodeURIComponent(url.href);
|
|
82
93
|
/** return Response redirect with http code of redirect type **/
|
|
@@ -141,13 +152,17 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
|
|
|
141
152
|
const redirects = yield this.redirectsService.fetchRedirects(siteName);
|
|
142
153
|
const tragetURL = req.nextUrl.pathname;
|
|
143
154
|
const targetQS = req.nextUrl.search || '';
|
|
144
|
-
|
|
145
|
-
|
|
155
|
+
const language = this.getLanguage(req);
|
|
156
|
+
const modifyRedirects = structuredClone(redirects);
|
|
157
|
+
return modifyRedirects.length
|
|
158
|
+
? modifyRedirects.find((redirect) => {
|
|
159
|
+
redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
|
|
146
160
|
redirect.pattern = `/^\/${redirect.pattern
|
|
147
161
|
.replace(/^\/|\/$/g, '')
|
|
148
162
|
.replace(/^\^\/|\/\$$/g, '')
|
|
149
163
|
.replace(/^\^|\$$/g, '')
|
|
150
|
-
.replace(
|
|
164
|
+
.replace(/(?<!\\)\?/g, '\\?')
|
|
165
|
+
.replace(/\$\/gi$/g, '')}[\/]?$/gi`;
|
|
151
166
|
return (((0, regex_parser_1.default)(redirect.pattern).test(tragetURL) ||
|
|
152
167
|
(0, regex_parser_1.default)(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
|
|
153
168
|
(0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RevalidateMiddleware = void 0;
|
|
4
|
+
var revalidate_middleware_1 = require("./revalidate-middleware");
|
|
5
|
+
Object.defineProperty(exports, "RevalidateMiddleware", { enumerable: true, get: function () { return revalidate_middleware_1.RevalidateMiddleware; } });
|