@sitecore-jss/sitecore-jss-nextjs 21.6.0-canary.3 → 21.6.0-canary.30
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 +1 -4
- package/context.d.ts +1 -0
- package/context.js +1 -0
- package/dist/cjs/context/context.js +63 -0
- package/dist/cjs/context/index.js +5 -0
- package/dist/cjs/editing/constants.js +6 -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 +31 -8
- package/dist/cjs/graphql/index.js +6 -0
- package/dist/cjs/index.js +10 -5
- package/dist/cjs/middleware/personalize-middleware.js +41 -32
- package/dist/cjs/services/base-graphql-sitemap-service.js +8 -0
- package/dist/esm/context/context.js +59 -0
- package/dist/esm/context/index.js +1 -0
- package/dist/esm/editing/constants.js +3 -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 +31 -8
- package/dist/esm/graphql/index.js +1 -0
- package/dist/esm/index.js +8 -2
- package/dist/esm/middleware/personalize-middleware.js +42 -33
- package/dist/esm/services/base-graphql-sitemap-service.js +9 -1
- package/graphql.d.ts +1 -0
- package/graphql.js +1 -0
- package/package.json +9 -8
- package/types/ComponentBuilder.d.ts +1 -0
- package/types/components/ComponentPropsContext.d.ts +1 -0
- package/types/components/Link.d.ts +1 -0
- package/types/components/NextImage.d.ts +1 -0
- package/types/components/Placeholder.d.ts +1 -0
- package/types/context/context.d.ts +104 -0
- package/types/context/index.d.ts +1 -0
- package/types/editing/constants.d.ts +3 -0
- package/types/editing/editing-data-service.d.ts +12 -4
- package/types/editing/editing-render-middleware.d.ts +10 -0
- package/types/graphql/index.d.ts +1 -0
- package/types/index.d.ts +6 -2
- package/types/middleware/personalize-middleware.d.ts +20 -15
- package/types/services/base-graphql-sitemap-service.d.ts +10 -3
- package/types/sharedTypes/module-factory.d.ts +1 -0
package/README.md
CHANGED
|
@@ -2,11 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.
|
|
4
4
|
|
|
5
|
-
<!---
|
|
6
|
-
@TODO: Update to next version docs before release
|
|
7
|
-
-->
|
|
8
5
|
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/21/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
|
|
9
6
|
|
|
10
7
|
[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
|
|
11
8
|
|
|
12
|
-
[API reference documentation](/ref-docs/sitecore-jss-nextjs/)
|
|
9
|
+
[API reference documentation](/ref-docs/sitecore-jss-nextjs/)
|
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');
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Context = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
|
|
6
|
+
*/
|
|
7
|
+
class Context {
|
|
8
|
+
constructor(props) {
|
|
9
|
+
this.props = props;
|
|
10
|
+
/**
|
|
11
|
+
* Indicates whether the Context and SDK(s) have been initialized
|
|
12
|
+
*/
|
|
13
|
+
this.isInitialized = false;
|
|
14
|
+
/**
|
|
15
|
+
* Software Development Kits (SDKs) to be initialized
|
|
16
|
+
*/
|
|
17
|
+
this.sdks = {};
|
|
18
|
+
/**
|
|
19
|
+
* Promises for the SDKs
|
|
20
|
+
*/
|
|
21
|
+
this.sdkPromises = {};
|
|
22
|
+
this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
|
|
23
|
+
this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
|
|
24
|
+
this.siteName = props.siteName;
|
|
25
|
+
}
|
|
26
|
+
init(props = {}) {
|
|
27
|
+
// Context and SDKs are initialized only once
|
|
28
|
+
if (this.isInitialized)
|
|
29
|
+
return;
|
|
30
|
+
this.isInitialized = true;
|
|
31
|
+
if (props.siteName) {
|
|
32
|
+
this.siteName = props.siteName;
|
|
33
|
+
}
|
|
34
|
+
// iterate over the SDKs and initialize them
|
|
35
|
+
for (const sdkName of Object.keys(this.props.sdks)) {
|
|
36
|
+
this.initSDK(sdkName);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
|
|
41
|
+
*
|
|
42
|
+
* @param {string} name SDK name
|
|
43
|
+
* @returns initialized SDK
|
|
44
|
+
*/
|
|
45
|
+
getSDK(name) {
|
|
46
|
+
return this.sdkPromises[name];
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Initializes the Software Development Kit (SDK)
|
|
50
|
+
*
|
|
51
|
+
* @param {T} name SDK name
|
|
52
|
+
* @returns {void}
|
|
53
|
+
*/
|
|
54
|
+
initSDK(name) {
|
|
55
|
+
this.sdkPromises[name] = new Promise((resolve) => {
|
|
56
|
+
this.props.sdks[name].init(this).then(() => {
|
|
57
|
+
this.sdks[name] = this.props.sdks[name].sdk;
|
|
58
|
+
resolve(this.sdks[name]);
|
|
59
|
+
});
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
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';
|
|
@@ -12,7 +12,7 @@ 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
|
|
15
|
+
const constants_1 = require("./constants");
|
|
16
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]')
|
|
@@ -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
16
|
const utils_1 = require("../utils/utils");
|
|
16
|
-
exports.QUERY_PARAM_EDITING_SECRET = 'secret';
|
|
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,6 +15,7 @@ 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 constants_2 = require("./constants");
|
|
18
19
|
const utils_1 = require("../utils/utils");
|
|
19
20
|
/**
|
|
20
21
|
* Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
|
|
@@ -26,6 +27,21 @@ class EditingRenderMiddleware {
|
|
|
26
27
|
*/
|
|
27
28
|
constructor(config) {
|
|
28
29
|
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
|
+
};
|
|
29
45
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
30
46
|
var _e, _f;
|
|
31
47
|
const { method, query, body, headers } = req;
|
|
@@ -44,7 +60,7 @@ class EditingRenderMiddleware {
|
|
|
44
60
|
});
|
|
45
61
|
}
|
|
46
62
|
// Validate secret
|
|
47
|
-
const secret = (_e = query[
|
|
63
|
+
const secret = (_e = query[constants_2.QUERY_PARAM_EDITING_SECRET]) !== null && _e !== void 0 ? _e : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
|
|
48
64
|
if (secret !== (0, utils_1.getJssEditingSecret)()) {
|
|
49
65
|
sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
|
|
50
66
|
return res.status(401).json({
|
|
@@ -56,21 +72,28 @@ class EditingRenderMiddleware {
|
|
|
56
72
|
const editingData = extractEditingData(req);
|
|
57
73
|
// Resolve server URL
|
|
58
74
|
const serverUrl = this.resolveServerUrl(req);
|
|
75
|
+
// Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
|
|
76
|
+
const params = this.getQueryParamsForPropagation(query);
|
|
59
77
|
// Stash for use later on (i.e. within getStatic/ServerSideProps).
|
|
60
78
|
// Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
|
|
61
79
|
// https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
|
|
62
|
-
const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
|
|
80
|
+
const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
|
|
63
81
|
// Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
|
|
64
82
|
res.setPreviewData(previewData);
|
|
65
83
|
// Grab the Next.js preview cookies to send on to the render request
|
|
66
84
|
const cookies = res.getHeader('Set-Cookie');
|
|
67
|
-
// Make actual render request for page route, passing on preview cookies.
|
|
85
|
+
// Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
|
|
68
86
|
// Note timestamp effectively disables caching the request in Axios (no amount of cache headers seemed to do it)
|
|
69
|
-
const requestUrl = this.resolvePageUrl(serverUrl, editingData.path);
|
|
70
87
|
sitecore_jss_1.debug.editing('fetching page route for %s', editingData.path);
|
|
71
|
-
const
|
|
88
|
+
const requestUrl = new URL(this.resolvePageUrl(serverUrl, editingData.path));
|
|
89
|
+
for (const key in params) {
|
|
90
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
91
|
+
requestUrl.searchParams.append(key, params[key]);
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
requestUrl.searchParams.append('timestamp', Date.now().toString());
|
|
72
95
|
const pageRes = yield this.dataFetcher
|
|
73
|
-
.get(
|
|
96
|
+
.get(requestUrl.toString(), {
|
|
74
97
|
headers: {
|
|
75
98
|
Cookie: cookies.join(';'),
|
|
76
99
|
},
|
|
@@ -85,7 +108,7 @@ class EditingRenderMiddleware {
|
|
|
85
108
|
});
|
|
86
109
|
let html = pageRes.data;
|
|
87
110
|
if (!html || html.length === 0) {
|
|
88
|
-
throw new Error(`Failed to render html for ${
|
|
111
|
+
throw new Error(`Failed to render html for ${editingData.path}`);
|
|
89
112
|
}
|
|
90
113
|
// replace phkey attribute with key attribute so that newly added renderings
|
|
91
114
|
// show correct placeholders, so save and refresh won't be needed after adding each rendering
|
|
@@ -101,7 +124,7 @@ class EditingRenderMiddleware {
|
|
|
101
124
|
// Handle component rendering. Extract component markup only
|
|
102
125
|
html = (_f = (0, node_html_parser_1.parse)(html).getElementById(layout_1.EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
|
|
103
126
|
if (!html)
|
|
104
|
-
throw new Error(`Failed to render component for ${
|
|
127
|
+
throw new Error(`Failed to render component for ${editingData.path}`);
|
|
105
128
|
}
|
|
106
129
|
const body = { html };
|
|
107
130
|
// Return expected JSON result
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getEdgeProxyContentUrl = exports.GraphQLRequestClient = void 0;
|
|
4
|
+
var graphql_1 = require("@sitecore-jss/sitecore-jss/graphql");
|
|
5
|
+
Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_1.GraphQLRequestClient; } });
|
|
6
|
+
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.
|
|
26
|
+
exports.FEaaSWrapper = 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.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.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.Context = exports.ComponentBuilder = exports.BYOCWrapper = 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; } });
|
|
@@ -33,6 +33,7 @@ Object.defineProperty(exports, "enableDebug", { enumerable: true, get: function
|
|
|
33
33
|
Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
|
|
34
34
|
// we will remove the root exports for these later
|
|
35
35
|
// we cannot mark exports as deprected directly, so we're using this hack instead
|
|
36
|
+
const graphql_1 = require("./graphql");
|
|
36
37
|
const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
|
|
37
38
|
const utils_2 = require("./utils");
|
|
38
39
|
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
|
|
@@ -50,6 +51,11 @@ exports.resolveUrl = resolveUrl;
|
|
|
50
51
|
exports.tryParseEnvValue = tryParseEnvValue;
|
|
51
52
|
exports.handleEditorFastRefresh = handleEditorFastRefresh;
|
|
52
53
|
exports.getPublicUrl = getPublicUrl;
|
|
54
|
+
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
|
|
55
|
+
const { GraphQLRequestClientDep: GraphQLRequestClient } = {
|
|
56
|
+
GraphQLRequestClientDep: graphql_1.GraphQLRequestClient,
|
|
57
|
+
};
|
|
58
|
+
exports.GraphQLRequestClient = GraphQLRequestClient;
|
|
53
59
|
var layout_1 = require("@sitecore-jss/sitecore-jss/layout");
|
|
54
60
|
Object.defineProperty(exports, "LayoutServicePageState", { enumerable: true, get: function () { return layout_1.LayoutServicePageState; } });
|
|
55
61
|
Object.defineProperty(exports, "GraphQLLayoutService", { enumerable: true, get: function () { return layout_1.GraphQLLayoutService; } });
|
|
@@ -72,9 +78,6 @@ Object.defineProperty(exports, "getPersonalizedRewrite", { enumerable: true, get
|
|
|
72
78
|
Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true, get: function () { return personalize_1.getPersonalizedRewriteData; } });
|
|
73
79
|
Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return personalize_1.normalizePersonalizedRewrite; } });
|
|
74
80
|
Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return personalize_1.CdpHelper; } });
|
|
75
|
-
Object.defineProperty(exports, "PosResolver", { enumerable: true, get: function () { return personalize_1.PosResolver; } });
|
|
76
|
-
var sitecore_jss_2 = require("@sitecore-jss/sitecore-jss");
|
|
77
|
-
Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return sitecore_jss_2.GraphQLRequestClient; } });
|
|
78
81
|
var component_props_service_1 = require("./services/component-props-service");
|
|
79
82
|
Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
|
|
80
83
|
var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
|
|
@@ -112,6 +115,8 @@ const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
|
|
|
112
115
|
exports.BYOCWrapper = BYOCWrapper;
|
|
113
116
|
var ComponentBuilder_1 = require("./ComponentBuilder");
|
|
114
117
|
Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
|
|
118
|
+
var context_1 = require("./context");
|
|
119
|
+
Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
|
|
115
120
|
var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
|
|
116
121
|
Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return sitecore_jss_react_1.Image; } });
|
|
117
122
|
Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return sitecore_jss_react_1.Text; } });
|
|
@@ -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;
|
|
@@ -51,16 +50,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
51
50
|
return response;
|
|
52
51
|
}
|
|
53
52
|
const site = this.getSite(req, response);
|
|
54
|
-
const engageServer = this.initializeEngageServer(site, language);
|
|
55
|
-
// creates the browser ID cookie on the server side
|
|
56
|
-
// and includes the cookie in the response header
|
|
57
|
-
try {
|
|
58
|
-
yield engageServer.handleCookie(req, response, timeout);
|
|
59
|
-
}
|
|
60
|
-
catch (error) {
|
|
61
|
-
sitecore_jss_1.debug.personalize('skipped (browser id generation failed)');
|
|
62
|
-
throw error;
|
|
63
|
-
}
|
|
64
53
|
// Get personalization info from Experience Edge
|
|
65
54
|
const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
|
|
66
55
|
if (!personalizeInfo) {
|
|
@@ -72,20 +61,20 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
72
61
|
sitecore_jss_1.debug.personalize('skipped (no personalization configured)');
|
|
73
62
|
return response;
|
|
74
63
|
}
|
|
64
|
+
yield this.initPersonalizeServer({
|
|
65
|
+
hostname,
|
|
66
|
+
siteName: site.name,
|
|
67
|
+
request: req,
|
|
68
|
+
response,
|
|
69
|
+
});
|
|
75
70
|
const params = this.getExperienceParams(req);
|
|
76
71
|
sitecore_jss_1.debug.personalize('executing experience for %s %s %o', personalizeInfo.contentId, params);
|
|
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
|
-
};
|
|
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;
|
|
@@ -104,15 +93,22 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
104
93
|
const rewritePath = (0, personalize_1.getPersonalizedRewrite)(basePath, { variantId });
|
|
105
94
|
// Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
|
|
106
95
|
const rewriteUrl = req.nextUrl.clone();
|
|
96
|
+
// Preserve cookies from previous response
|
|
97
|
+
const cookies = response.cookies.getAll();
|
|
107
98
|
rewriteUrl.pathname = rewritePath;
|
|
108
|
-
response = server_1.NextResponse.rewrite(rewriteUrl);
|
|
99
|
+
response = server_1.NextResponse.rewrite(rewriteUrl, response);
|
|
109
100
|
// Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
|
|
110
101
|
// See https://github.com/vercel/next.js/issues/32727
|
|
111
102
|
response.headers.set('x-middleware-cache', 'no-cache');
|
|
112
|
-
// Share rewrite path with following executed
|
|
103
|
+
// Share rewrite path with following executed middleware
|
|
113
104
|
response.headers.set('x-sc-rewrite', rewritePath);
|
|
114
105
|
// Share site name with the following executed middlewares
|
|
115
106
|
response.cookies.set(this.SITE_SYMBOL, site.name);
|
|
107
|
+
// Restore cookies from previous response since
|
|
108
|
+
// browserId cookie gets omitted after rewrite
|
|
109
|
+
cookies.forEach((cookie) => {
|
|
110
|
+
response.cookies.set(cookie);
|
|
111
|
+
});
|
|
116
112
|
sitecore_jss_1.debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
117
113
|
rewritePath,
|
|
118
114
|
headers: this.extractDebugHeaders(response.headers),
|
|
@@ -139,16 +135,29 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
139
135
|
}
|
|
140
136
|
});
|
|
141
137
|
}
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
:
|
|
149
|
-
|
|
138
|
+
initPersonalizeServer({ hostname, siteName, request, response, }) {
|
|
139
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
140
|
+
yield (0, server_2.init)({
|
|
141
|
+
sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
|
|
142
|
+
sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
|
|
143
|
+
siteName,
|
|
144
|
+
cookieDomain: hostname,
|
|
145
|
+
enableServerCookie: true,
|
|
146
|
+
}, request, response);
|
|
147
|
+
});
|
|
148
|
+
}
|
|
149
|
+
personalize({ params, personalizeInfo, language, timeout, }, request) {
|
|
150
|
+
var _a;
|
|
151
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
152
|
+
const personalizationData = {
|
|
153
|
+
channel: this.config.cdpConfig.channel || 'WEB',
|
|
154
|
+
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
|
|
155
|
+
friendlyId: personalizeInfo.contentId,
|
|
156
|
+
params,
|
|
157
|
+
language,
|
|
158
|
+
};
|
|
159
|
+
return (yield (0, server_2.personalize)(personalizationData, request, timeout));
|
|
150
160
|
});
|
|
151
|
-
return engageServer;
|
|
152
161
|
}
|
|
153
162
|
getExperienceParams(req) {
|
|
154
163
|
const utm = {
|
|
@@ -195,6 +195,14 @@ class BaseGraphQLSitemapService {
|
|
|
195
195
|
* @returns {GraphQLClient} implementation
|
|
196
196
|
*/
|
|
197
197
|
getGraphQLClient() {
|
|
198
|
+
if (!this.options.endpoint) {
|
|
199
|
+
if (!this.options.clientFactory) {
|
|
200
|
+
throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
|
|
201
|
+
}
|
|
202
|
+
return this.options.clientFactory({
|
|
203
|
+
debugger: sitecore_jss_1.debug.sitemap,
|
|
204
|
+
});
|
|
205
|
+
}
|
|
198
206
|
return new graphql_1.GraphQLRequestClient(this.options.endpoint, {
|
|
199
207
|
apiKey: this.options.apiKey,
|
|
200
208
|
debugger: sitecore_jss_1.debug.sitemap,
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
|
|
3
|
+
*/
|
|
4
|
+
export class Context {
|
|
5
|
+
constructor(props) {
|
|
6
|
+
this.props = props;
|
|
7
|
+
/**
|
|
8
|
+
* Indicates whether the Context and SDK(s) have been initialized
|
|
9
|
+
*/
|
|
10
|
+
this.isInitialized = false;
|
|
11
|
+
/**
|
|
12
|
+
* Software Development Kits (SDKs) to be initialized
|
|
13
|
+
*/
|
|
14
|
+
this.sdks = {};
|
|
15
|
+
/**
|
|
16
|
+
* Promises for the SDKs
|
|
17
|
+
*/
|
|
18
|
+
this.sdkPromises = {};
|
|
19
|
+
this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
|
|
20
|
+
this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
|
|
21
|
+
this.siteName = props.siteName;
|
|
22
|
+
}
|
|
23
|
+
init(props = {}) {
|
|
24
|
+
// Context and SDKs are initialized only once
|
|
25
|
+
if (this.isInitialized)
|
|
26
|
+
return;
|
|
27
|
+
this.isInitialized = true;
|
|
28
|
+
if (props.siteName) {
|
|
29
|
+
this.siteName = props.siteName;
|
|
30
|
+
}
|
|
31
|
+
// iterate over the SDKs and initialize them
|
|
32
|
+
for (const sdkName of Object.keys(this.props.sdks)) {
|
|
33
|
+
this.initSDK(sdkName);
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
|
|
38
|
+
*
|
|
39
|
+
* @param {string} name SDK name
|
|
40
|
+
* @returns initialized SDK
|
|
41
|
+
*/
|
|
42
|
+
getSDK(name) {
|
|
43
|
+
return this.sdkPromises[name];
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Initializes the Software Development Kit (SDK)
|
|
47
|
+
*
|
|
48
|
+
* @param {T} name SDK name
|
|
49
|
+
* @returns {void}
|
|
50
|
+
*/
|
|
51
|
+
initSDK(name) {
|
|
52
|
+
this.sdkPromises[name] = new Promise((resolve) => {
|
|
53
|
+
this.props.sdks[name].init(this).then(() => {
|
|
54
|
+
this.sdks[name] = this.props.sdks[name].sdk;
|
|
55
|
+
resolve(this.sdks[name]);
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { Context } from './context';
|
|
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
9
9
|
};
|
|
10
10
|
import { editingDataDiskCache } from './editing-data-cache';
|
|
11
11
|
import { isEditingData } from './editing-data';
|
|
12
|
-
import { QUERY_PARAM_EDITING_SECRET } from './
|
|
12
|
+
import { QUERY_PARAM_EDITING_SECRET } from './constants';
|
|
13
13
|
import { getJssEditingSecret } from '../utils/utils';
|
|
14
14
|
/**
|
|
15
15
|
* Middleware / handler for use in the editing data Next.js API dynamic route (e.g. '/api/editing/data/[key]')
|
|
@@ -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
|
}
|