@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.38 → 22.0.0-canary.42
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/README.md +5 -3
- 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/NextImage.js +2 -10
- package/dist/cjs/components/RichText.js +10 -10
- 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 +2 -2
- package/dist/cjs/editing/editing-data-service.js +15 -7
- package/dist/cjs/editing/editing-render-middleware.js +24 -10
- 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 +37 -25
- package/dist/cjs/middleware/index.js +3 -1
- 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 +48 -25
- package/dist/cjs/services/base-graphql-sitemap-service.js +7 -6
- package/dist/cjs/services/component-props-service.js +6 -6
- package/dist/cjs/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/NextImage.js +1 -8
- package/dist/esm/components/RichText.js +10 -10
- 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 +1 -1
- package/dist/esm/editing/editing-data-service.js +13 -5
- package/dist/esm/editing/editing-render-middleware.js +24 -10
- 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 -20
- package/dist/esm/middleware/index.js +1 -0
- 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 +48 -25
- package/dist/esm/services/base-graphql-sitemap-service.js +7 -6
- package/dist/esm/services/component-props-service.js +6 -6
- package/dist/esm/utils/utils.js +7 -13
- package/graphql.d.ts +1 -0
- package/graphql.js +1 -0
- package/package.json +15 -12
- 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 -0
- 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 -12
- package/types/middleware/index.d.ts +1 -0
- 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/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/utils/utils.d.ts +2 -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
|
@@ -7,10 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
7
7
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
8
|
});
|
|
9
9
|
};
|
|
10
|
+
import { QUERY_PARAM_EDITING_SECRET } from './constants';
|
|
10
11
|
import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
|
|
11
12
|
import { editingDataDiskCache } from './editing-data-cache';
|
|
12
13
|
import { getJssEditingSecret } from '../utils/utils';
|
|
13
|
-
export const QUERY_PARAM_EDITING_SECRET = 'secret';
|
|
14
14
|
/**
|
|
15
15
|
* Unique key generator.
|
|
16
16
|
* Need more than just the item GUID since requests are made "live" during editing in EE.
|
|
@@ -93,13 +93,14 @@ export class ServerlessEditingDataService {
|
|
|
93
93
|
* @param {string} serverUrl The server url to use for subsequent data API requests
|
|
94
94
|
* @returns {Promise} The {@link EditingPreviewData} containing the generated key and serverUrl to use for retrieval
|
|
95
95
|
*/
|
|
96
|
-
setEditingData(data, serverUrl) {
|
|
96
|
+
setEditingData(data, serverUrl, params) {
|
|
97
97
|
return __awaiter(this, void 0, void 0, function* () {
|
|
98
98
|
const key = this.generateKey(data);
|
|
99
|
-
const url = this.getUrl(serverUrl, key);
|
|
99
|
+
const url = this.getUrl(serverUrl, key, params);
|
|
100
100
|
const previewData = {
|
|
101
101
|
key,
|
|
102
102
|
serverUrl,
|
|
103
|
+
params,
|
|
103
104
|
};
|
|
104
105
|
debug.editing('storing editing data for %o: %o', previewData, data);
|
|
105
106
|
return this.dataFetcher.put(url, data).then(() => {
|
|
@@ -118,20 +119,27 @@ export class ServerlessEditingDataService {
|
|
|
118
119
|
if (!(editingPreviewData === null || editingPreviewData === void 0 ? void 0 : editingPreviewData.serverUrl)) {
|
|
119
120
|
return undefined;
|
|
120
121
|
}
|
|
121
|
-
const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key);
|
|
122
|
+
const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key, editingPreviewData.params);
|
|
122
123
|
debug.editing('retrieving editing data for %o', previewData);
|
|
123
124
|
return this.dataFetcher.get(url).then((response) => {
|
|
124
125
|
return response.data;
|
|
125
126
|
});
|
|
126
127
|
});
|
|
127
128
|
}
|
|
128
|
-
getUrl(serverUrl, key) {
|
|
129
|
+
getUrl(serverUrl, key, params) {
|
|
129
130
|
var _a;
|
|
130
131
|
// Example URL format:
|
|
131
132
|
// http://localhost:3000/api/editing/data/52961eea-bafd-5287-a532-a72e36bd8a36-qkb4e3fv5x?secret=1234secret
|
|
132
133
|
const apiRoute = (_a = this.apiRoute) === null || _a === void 0 ? void 0 : _a.replace('[key]', key);
|
|
133
134
|
const url = new URL(apiRoute, serverUrl);
|
|
134
135
|
url.searchParams.append(QUERY_PARAM_EDITING_SECRET, getJssEditingSecret());
|
|
136
|
+
if (params) {
|
|
137
|
+
for (const key in params) {
|
|
138
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
139
|
+
url.searchParams.append(key, params[key]);
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
135
143
|
return url.toString();
|
|
136
144
|
}
|
|
137
145
|
}
|
|
@@ -11,21 +11,25 @@ import { STATIC_PROPS_ID, SERVER_PROPS_ID } from 'next/constants';
|
|
|
11
11
|
import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
|
|
12
12
|
import { EDITING_COMPONENT_ID, RenderingType } from '@sitecore-jss/sitecore-jss/layout';
|
|
13
13
|
import { parse } from 'node-html-parser';
|
|
14
|
-
import { editingDataService
|
|
14
|
+
import { editingDataService } from './editing-data-service';
|
|
15
|
+
import { QUERY_PARAM_EDITING_SECRET } from './constants';
|
|
15
16
|
import { getJssEditingSecret } from '../utils/utils';
|
|
17
|
+
import { RenderMiddlewareBase } from './render-middleware';
|
|
16
18
|
/**
|
|
17
19
|
* Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
|
|
18
20
|
* which is required for Sitecore editing support.
|
|
19
21
|
*/
|
|
20
|
-
export class EditingRenderMiddleware {
|
|
22
|
+
export class EditingRenderMiddleware extends RenderMiddlewareBase {
|
|
21
23
|
/**
|
|
22
24
|
* @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
|
|
23
25
|
*/
|
|
24
26
|
constructor(config) {
|
|
25
27
|
var _a, _b, _c, _d;
|
|
28
|
+
super();
|
|
26
29
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
27
30
|
var _e, _f;
|
|
28
31
|
const { method, query, body, headers } = req;
|
|
32
|
+
const startTimestamp = Date.now();
|
|
29
33
|
debug.editing('editing render middleware start: %o', {
|
|
30
34
|
method,
|
|
31
35
|
query,
|
|
@@ -52,21 +56,28 @@ export class EditingRenderMiddleware {
|
|
|
52
56
|
const editingData = extractEditingData(req);
|
|
53
57
|
// Resolve server URL
|
|
54
58
|
const serverUrl = this.resolveServerUrl(req);
|
|
59
|
+
// Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
|
|
60
|
+
const params = this.getQueryParamsForPropagation(query);
|
|
55
61
|
// Stash for use later on (i.e. within getStatic/ServerSideProps).
|
|
56
62
|
// Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
|
|
57
63
|
// https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
|
|
58
|
-
const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
|
|
64
|
+
const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
|
|
59
65
|
// Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
|
|
60
66
|
res.setPreviewData(previewData);
|
|
61
67
|
// Grab the Next.js preview cookies to send on to the render request
|
|
62
68
|
const cookies = res.getHeader('Set-Cookie');
|
|
63
|
-
// Make actual render request for page route, passing on preview cookies.
|
|
69
|
+
// Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
|
|
64
70
|
// Note timestamp effectively disables caching the request in Axios (no amount of cache headers seemed to do it)
|
|
65
|
-
const requestUrl = this.resolvePageUrl(serverUrl, editingData.path);
|
|
66
71
|
debug.editing('fetching page route for %s', editingData.path);
|
|
67
|
-
const
|
|
72
|
+
const requestUrl = new URL(this.resolvePageUrl(serverUrl, editingData.path));
|
|
73
|
+
for (const key in params) {
|
|
74
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
75
|
+
requestUrl.searchParams.append(key, params[key]);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
requestUrl.searchParams.append('timestamp', Date.now().toString());
|
|
68
79
|
const pageRes = yield this.dataFetcher
|
|
69
|
-
.get(
|
|
80
|
+
.get(requestUrl.toString(), {
|
|
70
81
|
headers: {
|
|
71
82
|
Cookie: cookies.join(';'),
|
|
72
83
|
},
|
|
@@ -81,7 +92,7 @@ export class EditingRenderMiddleware {
|
|
|
81
92
|
});
|
|
82
93
|
let html = pageRes.data;
|
|
83
94
|
if (!html || html.length === 0) {
|
|
84
|
-
throw new Error(`Failed to render html for ${
|
|
95
|
+
throw new Error(`Failed to render html for ${editingData.path}`);
|
|
85
96
|
}
|
|
86
97
|
// replace phkey attribute with key attribute so that newly added renderings
|
|
87
98
|
// show correct placeholders, so save and refresh won't be needed after adding each rendering
|
|
@@ -97,11 +108,14 @@ export class EditingRenderMiddleware {
|
|
|
97
108
|
// Handle component rendering. Extract component markup only
|
|
98
109
|
html = (_f = parse(html).getElementById(EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
|
|
99
110
|
if (!html)
|
|
100
|
-
throw new Error(`Failed to render component for ${
|
|
111
|
+
throw new Error(`Failed to render component for ${editingData.path}`);
|
|
101
112
|
}
|
|
102
113
|
const body = { html };
|
|
103
114
|
// Return expected JSON result
|
|
104
|
-
debug.editing('editing render middleware end: %o',
|
|
115
|
+
debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
116
|
+
status: 200,
|
|
117
|
+
body,
|
|
118
|
+
});
|
|
105
119
|
res.status(200).json(body);
|
|
106
120
|
}
|
|
107
121
|
catch (err) {
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
11
|
+
import { QUERY_PARAM_EDITING_SECRET } from './constants';
|
|
12
|
+
import { getJssEditingSecret } from '../utils/utils';
|
|
13
|
+
import { RenderMiddlewareBase } from './render-middleware';
|
|
14
|
+
/**
|
|
15
|
+
* Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
|
|
16
|
+
* which is required for Sitecore editing support.
|
|
17
|
+
*/
|
|
18
|
+
export class FEAASRenderMiddleware extends RenderMiddlewareBase {
|
|
19
|
+
/**
|
|
20
|
+
* @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
|
|
21
|
+
*/
|
|
22
|
+
constructor(config) {
|
|
23
|
+
var _a;
|
|
24
|
+
super();
|
|
25
|
+
this.config = config;
|
|
26
|
+
this.defaultPageUrl = '/feaas/render';
|
|
27
|
+
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
28
|
+
const { method, query, headers } = req;
|
|
29
|
+
const startTimestamp = Date.now();
|
|
30
|
+
debug.editing('feaas render middleware start: %o', {
|
|
31
|
+
method,
|
|
32
|
+
query,
|
|
33
|
+
headers,
|
|
34
|
+
});
|
|
35
|
+
if (method !== 'GET') {
|
|
36
|
+
debug.editing('invalid method - sent %s expected GET', method);
|
|
37
|
+
res.setHeader('Allow', 'GET');
|
|
38
|
+
return res.status(405).send(`<html><body>Invalid request method '${method}'</body></html>`);
|
|
39
|
+
}
|
|
40
|
+
// Validate secret
|
|
41
|
+
const secret = query[QUERY_PARAM_EDITING_SECRET];
|
|
42
|
+
if (secret !== getJssEditingSecret()) {
|
|
43
|
+
debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
|
|
44
|
+
return res.status(401).send('<html><body>Missing or invalid secret</body></html>');
|
|
45
|
+
}
|
|
46
|
+
try {
|
|
47
|
+
// Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
|
|
48
|
+
const params = this.getQueryParamsForPropagation(query);
|
|
49
|
+
// Enable Next.js Preview Mode
|
|
50
|
+
res.setPreviewData({});
|
|
51
|
+
const queryParams = new URLSearchParams();
|
|
52
|
+
for (const key in params) {
|
|
53
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
54
|
+
queryParams.append(key, params[key]);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
// Pass "feaasSrc" in case a FEAASComponent is being requested
|
|
58
|
+
if (query.feaasSrc) {
|
|
59
|
+
queryParams.append('feaasSrc', query.feaasSrc);
|
|
60
|
+
}
|
|
61
|
+
const redirectUrl = this.pageUrl + (queryParams.toString() ? `?${queryParams.toString()}` : '');
|
|
62
|
+
debug.editing('redirecting to page route %s', redirectUrl);
|
|
63
|
+
debug.editing('feaas render middleware end in %dms', Date.now() - startTimestamp);
|
|
64
|
+
res.redirect(redirectUrl);
|
|
65
|
+
}
|
|
66
|
+
catch (err) {
|
|
67
|
+
const error = err;
|
|
68
|
+
console.info(
|
|
69
|
+
// eslint-disable-next-line quotes
|
|
70
|
+
"Hint: for non-standard server or Next.js route configurations, you may need to override the 'pageUrl' available on the 'FEAASRenderMiddleware' config.");
|
|
71
|
+
res.status(500).send(`<html><body>${error}</body></html>`);
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
this.pageUrl = (_a = config === null || config === void 0 ? void 0 : config.pageUrl) !== null && _a !== void 0 ? _a : this.defaultPageUrl;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Gets the Next.js API route handler
|
|
78
|
+
* @returns route handler
|
|
79
|
+
*/
|
|
80
|
+
getHandler() {
|
|
81
|
+
return this.handler;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
@@ -2,3 +2,6 @@ export { EditingDataDiskCache } from './editing-data-cache';
|
|
|
2
2
|
export { EditingDataMiddleware } from './editing-data-middleware';
|
|
3
3
|
export { EditingRenderMiddleware, } from './editing-render-middleware';
|
|
4
4
|
export { BasicEditingDataService, ServerlessEditingDataService, editingDataService, } from './editing-data-service';
|
|
5
|
+
export { VercelEditingDataCache } from './vercel-editing-data-cache';
|
|
6
|
+
export { FEAASRenderMiddleware } from './feaas-render-middleware';
|
|
7
|
+
export { EditingConfigMiddleware, } from './editing-config-middleware';
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { QUERY_PARAM_PROTECTION_BYPASS_SITECORE, QUERY_PARAM_PROTECTION_BYPASS_VERCEL, } from './constants';
|
|
2
|
+
/**
|
|
3
|
+
* Base class for middleware that handles pages and components rendering in Sitecore Editors.
|
|
4
|
+
*/
|
|
5
|
+
export class RenderMiddlewareBase {
|
|
6
|
+
constructor() {
|
|
7
|
+
/**
|
|
8
|
+
* Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
|
|
9
|
+
* @param {Object} query Object of query parameters from incoming URL
|
|
10
|
+
* @returns Object of approved query parameters
|
|
11
|
+
*/
|
|
12
|
+
this.getQueryParamsForPropagation = (query) => {
|
|
13
|
+
const params = {};
|
|
14
|
+
if (query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
|
|
15
|
+
params[QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
|
|
16
|
+
}
|
|
17
|
+
if (query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
|
|
18
|
+
params[QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
|
|
19
|
+
}
|
|
20
|
+
return params;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { createClient } from '@vercel/kv';
|
|
2
|
+
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
3
|
+
/**
|
|
4
|
+
* Implementation of editing cache for Vercel deployments
|
|
5
|
+
* Uses Vercel KV database and client to store data
|
|
6
|
+
* Set TTL for cache data in constructor (default: 60 seconds)
|
|
7
|
+
*/
|
|
8
|
+
export class VercelEditingDataCache {
|
|
9
|
+
/**
|
|
10
|
+
* @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
|
|
11
|
+
* @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
|
|
12
|
+
*/
|
|
13
|
+
constructor(redisUrl, redisToken) {
|
|
14
|
+
this.defaultTtl = 120;
|
|
15
|
+
if (!redisUrl || !redisToken) {
|
|
16
|
+
throw Error('API URL or token are missing, ensure you have set the KV or Upstash storage correctly.');
|
|
17
|
+
}
|
|
18
|
+
this.redisCache = createClient({
|
|
19
|
+
url: redisUrl,
|
|
20
|
+
token: redisToken,
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
set(key, editingData) {
|
|
24
|
+
debug.editing(`Putting editing data for ${key} into redis storage...`);
|
|
25
|
+
return new Promise((resolve, reject) => {
|
|
26
|
+
this.redisCache
|
|
27
|
+
.set(key, JSON.stringify(editingData), { ex: this.defaultTtl })
|
|
28
|
+
.then(() => resolve())
|
|
29
|
+
.catch((err) => reject(err));
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
get(key) {
|
|
33
|
+
debug.editing(`Getting editing data for ${key} from redis storage...`);
|
|
34
|
+
return new Promise((resolve, reject) => {
|
|
35
|
+
this.redisCache
|
|
36
|
+
.get(key)
|
|
37
|
+
.then((entry) => {
|
|
38
|
+
const result = (entry || undefined);
|
|
39
|
+
this.redisCache.expire(key, 0).then(() => resolve(result));
|
|
40
|
+
})
|
|
41
|
+
.catch((err) => reject(err));
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { DefaultRetryStrategy, GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
|
package/dist/esm/index.js
CHANGED
|
@@ -1,25 +1,9 @@
|
|
|
1
|
-
export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, } from '@sitecore-jss/sitecore-jss';
|
|
2
|
-
|
|
3
|
-
// we cannot mark exports as deprected directly, so we're using this hack instead
|
|
4
|
-
import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
|
|
5
|
-
import { handleEditorFastRefresh as handleEditorFastRefreshDep, getPublicUrl as getPublicUrlDep, } from './utils';
|
|
6
|
-
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
|
|
7
|
-
const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChromes, resolveUrlDep: resolveUrl, tryParseEnvValueDep: tryParseEnvValue, handleEditorFastRefreshDep: handleEditorFastRefresh, getPublicUrlDep: getPublicUrl, } = {
|
|
8
|
-
isEditorActiveDep,
|
|
9
|
-
resetEditorChromesDep,
|
|
10
|
-
resolveUrlDep,
|
|
11
|
-
tryParseEnvValueDep,
|
|
12
|
-
handleEditorFastRefreshDep,
|
|
13
|
-
getPublicUrlDep,
|
|
14
|
-
};
|
|
15
|
-
export { handleEditorFastRefresh, getPublicUrl };
|
|
16
|
-
export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
|
|
17
|
-
export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
|
|
1
|
+
export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
|
|
2
|
+
export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, getContentStylesheetLink, } from '@sitecore-jss/sitecore-jss/layout';
|
|
18
3
|
export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
|
|
19
4
|
export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
|
|
20
5
|
export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
|
|
21
|
-
export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper,
|
|
22
|
-
export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
|
|
6
|
+
export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
|
|
23
7
|
export { ComponentPropsService } from './services/component-props-service';
|
|
24
8
|
export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
|
|
25
9
|
export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
|
|
@@ -31,4 +15,10 @@ export { RichText } from './components/RichText';
|
|
|
31
15
|
export { Placeholder } from './components/Placeholder';
|
|
32
16
|
export { EditingComponentPlaceholder } from './components/EditingComponentPlaceholder';
|
|
33
17
|
export { NextImage } from './components/NextImage';
|
|
34
|
-
|
|
18
|
+
import * as FEaaSWrapper from './components/FEaaSWrapper';
|
|
19
|
+
import * as BYOCWrapper from './components/BYOCWrapper';
|
|
20
|
+
export { FEaaSWrapper };
|
|
21
|
+
export { BYOCWrapper };
|
|
22
|
+
export { ComponentBuilder } from './ComponentBuilder';
|
|
23
|
+
export { Context } from './context';
|
|
24
|
+
export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
+
import { NextResponse } from 'next/server';
|
|
1
2
|
export class MiddlewareBase {
|
|
2
3
|
constructor(config) {
|
|
3
4
|
this.config = config;
|
|
4
5
|
this.SITE_SYMBOL = 'sc_site';
|
|
6
|
+
this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
|
|
5
7
|
this.defaultHostname = config.defaultHostname || 'localhost';
|
|
6
8
|
}
|
|
7
9
|
/**
|
|
@@ -15,8 +17,7 @@ export class MiddlewareBase {
|
|
|
15
17
|
}
|
|
16
18
|
excludeRoute(pathname) {
|
|
17
19
|
var _a, _b;
|
|
18
|
-
return (pathname.
|
|
19
|
-
pathname.startsWith('/api/') || // Ignore Next.js API calls
|
|
20
|
+
return (pathname.startsWith('/api/') || // Ignore Next.js API calls
|
|
20
21
|
pathname.startsWith('/sitecore/') || // Ignore Sitecore API calls
|
|
21
22
|
pathname.startsWith('/_next') || // Ignore next service calls
|
|
22
23
|
(((_a = this.config) === null || _a === void 0 ? void 0 : _a.excludeRoute) && ((_b = this.config) === null || _b === void 0 ? void 0 : _b.excludeRoute(pathname))));
|
|
@@ -63,4 +64,19 @@ export class MiddlewareBase {
|
|
|
63
64
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
64
65
|
return this.config.siteResolver.getByHost(hostname);
|
|
65
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
* Create a rewrite response
|
|
69
|
+
* @param {string} rewritePath the destionation path
|
|
70
|
+
* @param {NextRequest} req the current request
|
|
71
|
+
* @param {NextResponse} res the current response
|
|
72
|
+
*/
|
|
73
|
+
rewrite(rewritePath, req, res) {
|
|
74
|
+
// Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
|
|
75
|
+
const rewriteUrl = req.nextUrl.clone();
|
|
76
|
+
rewriteUrl.pathname = rewritePath;
|
|
77
|
+
const response = NextResponse.rewrite(rewriteUrl, res);
|
|
78
|
+
// Share rewrite path with following executed middlewares
|
|
79
|
+
response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
|
|
80
|
+
return response;
|
|
81
|
+
}
|
|
66
82
|
}
|
|
@@ -26,6 +26,7 @@ export class MultisiteMiddleware extends MiddlewareBase {
|
|
|
26
26
|
const pathname = req.nextUrl.pathname;
|
|
27
27
|
const language = this.getLanguage(req);
|
|
28
28
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
29
|
+
const startTimestamp = Date.now();
|
|
29
30
|
debug.multisite('multisite middleware start: %o', {
|
|
30
31
|
pathname,
|
|
31
32
|
language,
|
|
@@ -47,15 +48,16 @@ export class MultisiteMiddleware extends MiddlewareBase {
|
|
|
47
48
|
const rewritePath = getSiteRewrite(pathname, {
|
|
48
49
|
siteName,
|
|
49
50
|
});
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
51
|
+
response = this.rewrite(rewritePath, req, response);
|
|
52
|
+
// default site cookie attributes
|
|
53
|
+
const defaultCookieAttributes = {
|
|
54
|
+
secure: true,
|
|
55
|
+
httpOnly: true,
|
|
56
|
+
sameSite: 'none',
|
|
57
|
+
};
|
|
54
58
|
// Share site name with the following executed middlewares
|
|
55
|
-
response.cookies.set(this.SITE_SYMBOL, siteName);
|
|
56
|
-
|
|
57
|
-
response.headers.set('x-sc-rewrite', rewritePath);
|
|
58
|
-
debug.multisite('multisite middleware end: %o', {
|
|
59
|
+
response.cookies.set(this.SITE_SYMBOL, siteName, defaultCookieAttributes);
|
|
60
|
+
debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
59
61
|
rewritePath,
|
|
60
62
|
siteName,
|
|
61
63
|
headers: this.extractDebugHeaders(response.headers),
|
|
@@ -80,4 +82,8 @@ export class MultisiteMiddleware extends MiddlewareBase {
|
|
|
80
82
|
}
|
|
81
83
|
});
|
|
82
84
|
}
|
|
85
|
+
excludeRoute(pathname) {
|
|
86
|
+
// ignore files
|
|
87
|
+
return pathname.includes('.') || super.excludeRoute(pathname);
|
|
88
|
+
}
|
|
83
89
|
}
|
|
@@ -7,10 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
7
7
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
8
|
});
|
|
9
9
|
};
|
|
10
|
-
import { NextResponse
|
|
11
|
-
import { GraphQLPersonalizeService,
|
|
12
|
-
import { debug
|
|
10
|
+
import { NextResponse } from 'next/server';
|
|
11
|
+
import { GraphQLPersonalizeService, getPersonalizedRewrite, } from '@sitecore-jss/sitecore-jss/personalize';
|
|
12
|
+
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
13
13
|
import { MiddlewareBase } from './middleware';
|
|
14
|
+
import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
|
|
14
15
|
/**
|
|
15
16
|
* Middleware / handler to support Sitecore Personalize
|
|
16
17
|
*/
|
|
@@ -25,15 +26,16 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
25
26
|
const pathname = req.nextUrl.pathname;
|
|
26
27
|
const language = this.getLanguage(req);
|
|
27
28
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
28
|
-
|
|
29
|
+
const startTimestamp = Date.now();
|
|
30
|
+
const timeout = this.config.cdpConfig.timeout;
|
|
31
|
+
// Response will be provided if other middleware is run before us (e.g. redirects)
|
|
32
|
+
let response = res || NextResponse.next();
|
|
29
33
|
debug.personalize('personalize middleware start: %o', {
|
|
30
34
|
pathname,
|
|
31
35
|
language,
|
|
32
36
|
hostname,
|
|
33
|
-
|
|
37
|
+
headers: this.extractDebugHeaders(req.headers),
|
|
34
38
|
});
|
|
35
|
-
// Response will be provided if other middleware is run before us (e.g. redirects)
|
|
36
|
-
let response = res || NextResponse.next();
|
|
37
39
|
if (this.config.disabled && this.config.disabled(req, response)) {
|
|
38
40
|
debug.personalize('skipped (personalize middleware is disabled)');
|
|
39
41
|
return response;
|
|
@@ -44,7 +46,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
44
46
|
debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
|
|
45
47
|
return response;
|
|
46
48
|
}
|
|
47
|
-
const site = this.getSite(req,
|
|
49
|
+
const site = this.getSite(req, response);
|
|
48
50
|
// Get personalization info from Experience Edge
|
|
49
51
|
const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
|
|
50
52
|
if (!personalizeInfo) {
|
|
@@ -56,20 +58,24 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
56
58
|
debug.personalize('skipped (no personalization configured)');
|
|
57
59
|
return response;
|
|
58
60
|
}
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
}
|
|
66
|
-
// Execute targeted experience in CDP
|
|
67
|
-
const { ua } = userAgent(req);
|
|
61
|
+
yield this.initPersonalizeServer({
|
|
62
|
+
hostname,
|
|
63
|
+
siteName: site.name,
|
|
64
|
+
request: req,
|
|
65
|
+
response,
|
|
66
|
+
});
|
|
68
67
|
const params = this.getExperienceParams(req);
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
68
|
+
debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
|
|
69
|
+
let variantId;
|
|
70
|
+
// Execute targeted experience in Personalize SDK
|
|
71
|
+
// eslint-disable-next-line no-useless-catch
|
|
72
|
+
try {
|
|
73
|
+
const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
|
|
74
|
+
variantId = personalization.variantId;
|
|
75
|
+
}
|
|
76
|
+
catch (error) {
|
|
77
|
+
throw error;
|
|
78
|
+
}
|
|
73
79
|
if (!variantId) {
|
|
74
80
|
debug.personalize('skipped (no variant identified)');
|
|
75
81
|
return response;
|
|
@@ -82,22 +88,12 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
82
88
|
const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
|
|
83
89
|
// Rewrite to persononalized path
|
|
84
90
|
const rewritePath = getPersonalizedRewrite(basePath, { variantId });
|
|
85
|
-
|
|
86
|
-
const rewriteUrl = req.nextUrl.clone();
|
|
87
|
-
rewriteUrl.pathname = rewritePath;
|
|
88
|
-
response = NextResponse.rewrite(rewriteUrl);
|
|
91
|
+
response = this.rewrite(rewritePath, req, response);
|
|
89
92
|
// Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
|
|
90
93
|
// See https://github.com/vercel/next.js/issues/32727
|
|
91
94
|
response.headers.set('x-middleware-cache', 'no-cache');
|
|
92
|
-
|
|
93
|
-
response.headers.set('x-sc-rewrite', rewritePath);
|
|
94
|
-
// Set browserId cookie on the response
|
|
95
|
-
this.setBrowserId(response, browserId);
|
|
96
|
-
// Share site name with the following executed middlewares
|
|
97
|
-
response.cookies.set(this.SITE_SYMBOL, site.name);
|
|
98
|
-
debug.personalize('personalize middleware end: %o', {
|
|
95
|
+
debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
99
96
|
rewritePath,
|
|
100
|
-
browserId,
|
|
101
97
|
headers: this.extractDebugHeaders(response.headers),
|
|
102
98
|
});
|
|
103
99
|
return response;
|
|
@@ -105,15 +101,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
105
101
|
// NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
|
|
106
102
|
// (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
|
|
107
103
|
this.personalizeService = new GraphQLPersonalizeService(Object.assign(Object.assign({}, config.edgeConfig), { fetch: fetch }));
|
|
108
|
-
// NOTE: same here, we provide NativeDataFetcher for compatibility on Next.js Edge Runtime
|
|
109
|
-
this.cdpService = new CdpService(Object.assign(Object.assign({}, config.cdpConfig), { dataFetcherResolver: ({ timeout, headers, }) => {
|
|
110
|
-
const fetcher = new NativeDataFetcher({
|
|
111
|
-
debugger: debug.personalize,
|
|
112
|
-
timeout,
|
|
113
|
-
headers,
|
|
114
|
-
});
|
|
115
|
-
return (url, data) => fetcher.fetch(url, data);
|
|
116
|
-
} }));
|
|
117
104
|
}
|
|
118
105
|
/**
|
|
119
106
|
* Gets the Next.js middleware handler with error handling
|
|
@@ -131,28 +118,47 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
131
118
|
}
|
|
132
119
|
});
|
|
133
120
|
}
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
121
|
+
initPersonalizeServer({ hostname, siteName, request, response, }) {
|
|
122
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
123
|
+
yield init(request, response, {
|
|
124
|
+
sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
|
|
125
|
+
sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
|
|
126
|
+
siteName,
|
|
127
|
+
cookieDomain: hostname,
|
|
128
|
+
enableServerCookie: true,
|
|
129
|
+
});
|
|
130
|
+
});
|
|
137
131
|
}
|
|
138
|
-
|
|
132
|
+
personalize({ params, personalizeInfo, language, timeout, }, request) {
|
|
139
133
|
var _a;
|
|
140
|
-
return (
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
134
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
135
|
+
const personalizationData = {
|
|
136
|
+
channel: this.config.cdpConfig.channel || 'WEB',
|
|
137
|
+
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
|
|
138
|
+
friendlyId: personalizeInfo.contentId,
|
|
139
|
+
params,
|
|
140
|
+
language,
|
|
141
|
+
};
|
|
142
|
+
return (yield personalize(request, personalizationData, { timeout }));
|
|
143
|
+
});
|
|
146
144
|
}
|
|
147
145
|
getExperienceParams(req) {
|
|
146
|
+
const utm = {
|
|
147
|
+
campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined,
|
|
148
|
+
content: req.nextUrl.searchParams.get('utm_content') || undefined,
|
|
149
|
+
medium: req.nextUrl.searchParams.get('utm_medium') || undefined,
|
|
150
|
+
source: req.nextUrl.searchParams.get('utm_source') || undefined,
|
|
151
|
+
};
|
|
148
152
|
return {
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
source: req.nextUrl.searchParams.get('utm_source'),
|
|
155
|
-
},
|
|
153
|
+
// It's expected that the header name "referer" is actually a misspelling of the word "referrer"
|
|
154
|
+
// req.referrer is used during fetching to determine the value of the Referer header of the request being made,
|
|
155
|
+
// used as a fallback
|
|
156
|
+
referrer: req.headers.get('referer') || req.referrer,
|
|
157
|
+
utm: utm,
|
|
156
158
|
};
|
|
157
159
|
}
|
|
160
|
+
excludeRoute(pathname) {
|
|
161
|
+
// ignore files
|
|
162
|
+
return pathname.includes('.') || super.excludeRoute(pathname);
|
|
163
|
+
}
|
|
158
164
|
}
|