@sitecore-jss/sitecore-jss-nextjs 21.6.0-canary.22 → 21.6.0-canary.23

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.
Files changed (29) hide show
  1. package/dist/cjs/editing/constants.js +6 -0
  2. package/dist/cjs/editing/editing-data-middleware.js +2 -2
  3. package/dist/cjs/editing/editing-data-service.js +15 -7
  4. package/dist/cjs/editing/editing-render-middleware.js +31 -8
  5. package/dist/cjs/graphql/index.js +6 -0
  6. package/dist/cjs/index.js +7 -3
  7. package/dist/cjs/services/base-graphql-sitemap-service.js +8 -0
  8. package/dist/esm/editing/constants.js +3 -0
  9. package/dist/esm/editing/editing-data-middleware.js +1 -1
  10. package/dist/esm/editing/editing-data-service.js +13 -5
  11. package/dist/esm/editing/editing-render-middleware.js +31 -8
  12. package/dist/esm/graphql/index.js +1 -0
  13. package/dist/esm/index.js +6 -1
  14. package/dist/esm/services/base-graphql-sitemap-service.js +9 -1
  15. package/graphql.d.ts +1 -0
  16. package/graphql.js +1 -0
  17. package/package.json +5 -5
  18. package/types/ComponentBuilder.d.ts +1 -0
  19. package/types/components/ComponentPropsContext.d.ts +1 -0
  20. package/types/components/Link.d.ts +1 -0
  21. package/types/components/NextImage.d.ts +1 -0
  22. package/types/components/Placeholder.d.ts +1 -0
  23. package/types/editing/constants.d.ts +3 -0
  24. package/types/editing/editing-data-service.d.ts +12 -4
  25. package/types/editing/editing-render-middleware.d.ts +10 -0
  26. package/types/graphql/index.d.ts +1 -0
  27. package/types/index.d.ts +4 -1
  28. package/types/services/base-graphql-sitemap-service.d.ts +10 -3
  29. package/types/sharedTypes/module-factory.d.ts +1 -0
package/dist/cjs/editing/constants.js ADDED
@@ -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';
package/dist/cjs/editing/editing-data-middleware.js CHANGED
@@ -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 editing_data_service_1 = require("./editing-data-service");
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[editing_data_service_1.QUERY_PARAM_EDITING_SECRET];
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)()) {
package/dist/cjs/editing/editing-data-service.js CHANGED
@@ -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 = exports.QUERY_PARAM_EDITING_SECRET = void 0;
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(exports.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
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
  }
package/dist/cjs/editing/editing-render-middleware.js CHANGED
@@ -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[editing_data_service_1.QUERY_PARAM_EDITING_SECRET]) !== null && _e !== void 0 ? _e : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
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 queryStringCharacter = requestUrl.indexOf('?') === -1 ? '?' : '&';
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(`${requestUrl}${queryStringCharacter}timestamp=${Date.now()}`, {
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 ${requestUrl}`);
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 ${requestUrl}`);
127
+ throw new Error(`Failed to render component for ${editingData.path}`);
105
128
  }
106
129
  const body = { html };
107
130
  // Return expected JSON result
package/dist/cjs/graphql/index.js ADDED
@@ -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,7 +23,7 @@ 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.GraphQLRequestClient = exports.PosResolver = 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.debug = exports.enableDebug = exports.NativeDataFetcher = exports.AxiosDataFetcher = exports.constants = 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.PosResolver = 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
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;
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; } });
@@ -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; } });
@@ -73,8 +79,6 @@ Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true,
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
81
  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
82
  var component_props_service_1 = require("./services/component-props-service");
79
83
  Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
80
84
  var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
package/dist/cjs/services/base-graphql-sitemap-service.js CHANGED
@@ -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,
package/dist/esm/editing/constants.js ADDED
@@ -0,0 +1,3 @@
1
+ export const QUERY_PARAM_EDITING_SECRET = 'secret';
2
+ export const QUERY_PARAM_PROTECTION_BYPASS_SITECORE = 'x-sitecore-protection-bypass';
3
+ export const QUERY_PARAM_PROTECTION_BYPASS_VERCEL = 'x-vercel-protection-bypass';
package/dist/esm/editing/editing-data-middleware.js CHANGED
@@ -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 './editing-data-service';
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]')
package/dist/esm/editing/editing-data-service.js CHANGED
@@ -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
  }
package/dist/esm/editing/editing-render-middleware.js CHANGED
@@ -11,7 +11,8 @@ 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, QUERY_PARAM_EDITING_SECRET, } from './editing-data-service';
14
+ import { editingDataService } from './editing-data-service';
15
+ import { QUERY_PARAM_EDITING_SECRET, QUERY_PARAM_PROTECTION_BYPASS_SITECORE, QUERY_PARAM_PROTECTION_BYPASS_VERCEL, } from './constants';
15
16
  import { getJssEditingSecret } from '../utils/utils';
16
17
  /**
17
18
  * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
@@ -23,6 +24,21 @@ export class EditingRenderMiddleware {
23
24
  */
24
25
  constructor(config) {
25
26
  var _a, _b, _c, _d;
27
+ /**
28
+ * Gets query parameters that should be passed along to subsequent requests
29
+ * @param query Object of query parameters from incoming URL
30
+ * @returns Object of approved query parameters
31
+ */
32
+ this.getQueryParamsForPropagation = (query) => {
33
+ const params = {};
34
+ if (query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
35
+ params[QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
36
+ }
37
+ if (query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
38
+ params[QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
39
+ }
40
+ return params;
41
+ };
26
42
  this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
27
43
  var _e, _f;
28
44
  const { method, query, body, headers } = req;
@@ -53,21 +69,28 @@ export class EditingRenderMiddleware {
53
69
  const editingData = extractEditingData(req);
54
70
  // Resolve server URL
55
71
  const serverUrl = this.resolveServerUrl(req);
72
+ // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
73
+ const params = this.getQueryParamsForPropagation(query);
56
74
  // Stash for use later on (i.e. within getStatic/ServerSideProps).
57
75
  // Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
58
76
  // https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
59
- const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
77
+ const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
60
78
  // Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
61
79
  res.setPreviewData(previewData);
62
80
  // Grab the Next.js preview cookies to send on to the render request
63
81
  const cookies = res.getHeader('Set-Cookie');
64
- // Make actual render request for page route, passing on preview cookies.
82
+ // Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
65
83
  // Note timestamp effectively disables caching the request in Axios (no amount of cache headers seemed to do it)
66
- const requestUrl = this.resolvePageUrl(serverUrl, editingData.path);
67
84
  debug.editing('fetching page route for %s', editingData.path);
68
- const queryStringCharacter = requestUrl.indexOf('?') === -1 ? '?' : '&';
85
+ const requestUrl = new URL(this.resolvePageUrl(serverUrl, editingData.path));
86
+ for (const key in params) {
87
+ if ({}.hasOwnProperty.call(params, key)) {
88
+ requestUrl.searchParams.append(key, params[key]);
89
+ }
90
+ }
91
+ requestUrl.searchParams.append('timestamp', Date.now().toString());
69
92
  const pageRes = yield this.dataFetcher
70
- .get(`${requestUrl}${queryStringCharacter}timestamp=${Date.now()}`, {
93
+ .get(requestUrl.toString(), {
71
94
  headers: {
72
95
  Cookie: cookies.join(';'),
73
96
  },
@@ -82,7 +105,7 @@ export class EditingRenderMiddleware {
82
105
  });
83
106
  let html = pageRes.data;
84
107
  if (!html || html.length === 0) {
85
- throw new Error(`Failed to render html for ${requestUrl}`);
108
+ throw new Error(`Failed to render html for ${editingData.path}`);
86
109
  }
87
110
  // replace phkey attribute with key attribute so that newly added renderings
88
111
  // show correct placeholders, so save and refresh won't be needed after adding each rendering
@@ -98,7 +121,7 @@ export class EditingRenderMiddleware {
98
121
  // Handle component rendering. Extract component markup only
99
122
  html = (_f = parse(html).getElementById(EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
100
123
  if (!html)
101
- throw new Error(`Failed to render component for ${requestUrl}`);
124
+ throw new Error(`Failed to render component for ${editingData.path}`);
102
125
  }
103
126
  const body = { html };
104
127
  // Return expected JSON result
package/dist/esm/graphql/index.js ADDED
@@ -0,0 +1 @@
1
+ export { GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
package/dist/esm/index.js CHANGED
@@ -1,6 +1,7 @@
1
1
  export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
2
2
  // we will remove the root exports for these later
3
3
  // we cannot mark exports as deprected directly, so we're using this hack instead
4
+ import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
4
5
  import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
5
6
  import { handleEditorFastRefresh as handleEditorFastRefreshDep, getPublicUrl as getPublicUrlDep, } from './utils';
6
7
  /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
@@ -12,6 +13,11 @@ const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChr
12
13
  handleEditorFastRefreshDep,
13
14
  getPublicUrlDep,
14
15
  };
16
+ /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
17
+ const { GraphQLRequestClientDep: GraphQLRequestClient } = {
18
+ GraphQLRequestClientDep,
19
+ };
20
+ export { GraphQLRequestClient };
15
21
  export { handleEditorFastRefresh, getPublicUrl };
16
22
  export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
17
23
  export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
@@ -19,7 +25,6 @@ export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
19
25
  export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
20
26
  export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
21
27
  export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
22
- export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
23
28
  export { ComponentPropsService } from './services/component-props-service';
24
29
  export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
25
30
  export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
package/dist/esm/services/base-graphql-sitemap-service.js CHANGED
@@ -7,7 +7,7 @@ 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 { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss/graphql';
10
+ import { GraphQLRequestClient, } from '@sitecore-jss/sitecore-jss/graphql';
11
11
  import { debug } from '@sitecore-jss/sitecore-jss';
12
12
  import { getPersonalizedRewrite } from '@sitecore-jss/sitecore-jss/personalize';
13
13
  /** @private */
@@ -191,6 +191,14 @@ export class BaseGraphQLSitemapService {
191
191
  * @returns {GraphQLClient} implementation
192
192
  */
193
193
  getGraphQLClient() {
194
+ if (!this.options.endpoint) {
195
+ if (!this.options.clientFactory) {
196
+ throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
197
+ }
198
+ return this.options.clientFactory({
199
+ debugger: debug.sitemap,
200
+ });
201
+ }
194
202
  return new GraphQLRequestClient(this.options.endpoint, {
195
203
  apiKey: this.options.apiKey,
196
204
  debugger: debug.sitemap,
package/graphql.d.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './types/graphql/index';
package/graphql.js ADDED
@@ -0,0 +1 @@
1
+ module.exports = require('./dist/cjs/graphql/index');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore-jss/sitecore-jss-nextjs",
3
- "version": "21.6.0-canary.22",
3
+ "version": "21.6.0-canary.23",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "sideEffects": false,
@@ -72,9 +72,9 @@
72
72
  "react-dom": "^18.2.0"
73
73
  },
74
74
  "dependencies": {
75
- "@sitecore-jss/sitecore-jss": "^21.6.0-canary.22",
76
- "@sitecore-jss/sitecore-jss-dev-tools": "^21.6.0-canary.22",
77
- "@sitecore-jss/sitecore-jss-react": "^21.6.0-canary.22",
75
+ "@sitecore-jss/sitecore-jss": "^21.6.0-canary.23",
76
+ "@sitecore-jss/sitecore-jss-dev-tools": "^21.6.0-canary.23",
77
+ "@sitecore-jss/sitecore-jss-react": "^21.6.0-canary.23",
78
78
  "@vercel/kv": "^0.2.1",
79
79
  "node-html-parser": "^6.1.4",
80
80
  "prop-types": "^15.8.1",
@@ -83,7 +83,7 @@
83
83
  },
84
84
  "description": "",
85
85
  "types": "types/index.d.ts",
86
- "gitHead": "4f902b49bd406cec630749bb1b192c3e3370a0a3",
86
+ "gitHead": "4377bed9deb0cbc8d0c86cd2462a48505194f5f2",
87
87
  "files": [
88
88
  "dist",
89
89
  "types",
package/types/ComponentBuilder.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="@types/react" />
1
2
  import { ComponentFactory } from '@sitecore-jss/sitecore-jss-react';
2
3
  import { Module, ModuleFactory } from './sharedTypes/module-factory';
3
4
  import { ComponentType } from 'react';
package/types/components/ComponentPropsContext.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="@types/react" />
1
2
  import React, { ReactNode } from 'react';
2
3
  import { ComponentPropsCollection } from '../sharedTypes/component-props';
3
4
  /**
package/types/components/Link.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="@types/react" />
1
2
  import React from 'react';
2
3
  import { LinkProps as ReactLinkProps } from '@sitecore-jss/sitecore-jss-react';
3
4
  export type LinkProps = ReactLinkProps & {
package/types/components/NextImage.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="@types/react" />
1
2
  import React from 'react';
2
3
  import { ImageProps } from '@sitecore-jss/sitecore-jss-react';
3
4
  import { ImageLoader, ImageProps as NextImageProperties } from 'next/image';
package/types/components/Placeholder.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="@types/react" />
1
2
  import React from 'react';
2
3
  import { PlaceholderComponentProps } from '@sitecore-jss/sitecore-jss-react';
3
4
  export declare const Placeholder: (props: PlaceholderComponentProps) => React.JSX.Element;
package/types/editing/constants.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export declare const QUERY_PARAM_EDITING_SECRET = "secret";
2
+ export declare const QUERY_PARAM_PROTECTION_BYPASS_SITECORE = "x-sitecore-protection-bypass";
3
+ export declare const QUERY_PARAM_PROTECTION_BYPASS_VERCEL = "x-vercel-protection-bypass";
package/types/editing/editing-data-service.d.ts CHANGED
@@ -2,13 +2,15 @@ import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
2
2
  import { EditingData } from './editing-data';
3
3
  import { EditingDataCache } from './editing-data-cache';
4
4
  import { PreviewData } from 'next';
5
- export declare const QUERY_PARAM_EDITING_SECRET = "secret";
6
5
  /**
7
6
  * Data for Next.js Preview (Editing) mode
8
7
  */
9
8
  export interface EditingPreviewData {
10
9
  key: string;
11
10
  serverUrl?: string;
11
+ params?: {
12
+ [key: string]: string;
13
+ };
12
14
  }
13
15
  /**
14
16
  * Defines an editing data service implementation
@@ -20,7 +22,9 @@ export interface EditingDataService {
20
22
  * @param {string} serverUrl The server url e.g. which can be used for further API requests
21
23
  * @returns The {@link EditingPreviewData} containing the information to use for retrieval
22
24
  */
23
- setEditingData(data: EditingData, serverUrl: string): Promise<EditingPreviewData>;
25
+ setEditingData(data: EditingData, serverUrl: string, params?: {
26
+ [key: string]: string;
27
+ }): Promise<EditingPreviewData>;
24
28
  /**
25
29
  * Retrieves Sitecore editor payload data
26
30
  * @param {PreviewData} previewData Editing preview data containing the information to use for retrieval
@@ -107,14 +111,18 @@ export declare class ServerlessEditingDataService implements EditingDataService
107
111
  * @param {string} serverUrl The server url to use for subsequent data API requests
108
112
  * @returns {Promise} The {@link EditingPreviewData} containing the generated key and serverUrl to use for retrieval
109
113
  */
110
- setEditingData(data: EditingData, serverUrl: string): Promise<EditingPreviewData>;
114
+ setEditingData(data: EditingData, serverUrl: string, params?: {
115
+ [key: string]: string;
116
+ }): Promise<EditingPreviewData>;
111
117
  /**
112
118
  * Retrieves Sitecore editor payload data by key
113
119
  * @param {PreviewData} previewData Editing preview data containing the key and serverUrl to use for retrieval
114
120
  * @returns {Promise} The {@link EditingData}
115
121
  */
116
122
  getEditingData(previewData: PreviewData): Promise<EditingData | undefined>;
117
- protected getUrl(serverUrl: string, key: string): string;
123
+ protected getUrl(serverUrl: string, key: string, params?: {
124
+ [key: string]: string;
125
+ }): string;
118
126
  }
119
127
  /**
120
128
  * The `EditingDataService` default instance.
package/types/editing/editing-render-middleware.d.ts CHANGED
@@ -55,6 +55,16 @@ export declare class EditingRenderMiddleware {
55
55
  * @returns route handler
56
56
  */
57
57
  getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
58
+ /**
59
+ * Gets query parameters that should be passed along to subsequent requests
60
+ * @param query Object of query parameters from incoming URL
61
+ * @returns Object of approved query parameters
62
+ */
63
+ protected getQueryParamsForPropagation: (query: Partial<{
64
+ [key: string]: string | string[];
65
+ }>) => {
66
+ [key: string]: string;
67
+ };
58
68
  private handler;
59
69
  /**
60
70
  * Default page URL resolution.
package/types/graphql/index.d.ts ADDED
@@ -0,0 +1 @@
1
+ export { GraphQLRequestClient, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
package/types/index.d.ts CHANGED
@@ -1,7 +1,11 @@
1
1
  export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
2
+ import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
2
3
  import { resolveUrl as resolveUrlDep } from '@sitecore-jss/sitecore-jss/utils';
3
4
  /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
4
5
  declare const isEditorActive: () => boolean, resetEditorChromes: () => void, resolveUrl: typeof resolveUrlDep, tryParseEnvValue: <T>(envValue: string | undefined, defaultValue: T) => T, handleEditorFastRefresh: (forceReload?: boolean) => void, getPublicUrl: () => string;
6
+ /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
7
+ declare const GraphQLRequestClient: typeof GraphQLRequestClientDep;
8
+ export { GraphQLRequestClient };
5
9
  export { handleEditorFastRefresh, getPublicUrl };
6
10
  export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
7
11
  export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, RestLayoutService, RestLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
@@ -9,7 +13,6 @@ export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
9
13
  export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
10
14
  export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
11
15
  export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
12
- export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
13
16
  export { ComponentPropsCollection, ComponentPropsError, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
14
17
  export { ModuleFactory, Module } from './sharedTypes/module-factory';
15
18
  export { ComponentPropsService } from './services/component-props-service';
package/types/services/base-graphql-sitemap-service.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { GraphQLClient, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
1
+ import { GraphQLClient, GraphQLRequestClientFactory, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
2
2
  /** @private */
3
3
  export declare const languageError = "The list of languages cannot be empty";
4
4
  export declare const siteError = "The service needs a site name";
@@ -68,17 +68,24 @@ export type RouteListQueryResult = {
68
68
  export interface BaseGraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariables, 'language' | 'siteName'> {
69
69
  /**
70
70
  * Your Graphql endpoint
71
+ * @deprecated use @param clientFactory property instead
71
72
  */
72
- endpoint: string;
73
+ endpoint?: string;
73
74
  /**
74
75
  * The API key to use for authentication.
76
+ * @deprecated use @param clientFactory property instead
75
77
  */
76
- apiKey: string;
78
+ apiKey?: string;
77
79
  /**
78
80
  * A flag for whether to include personalized routes in service output - only works on XM Cloud
79
81
  * turned off by default
80
82
  */
81
83
  includePersonalizedRoutes?: boolean;
84
+ /**
85
+ * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
86
+ * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
87
+ */
88
+ clientFactory?: GraphQLRequestClientFactory;
82
89
  }
83
90
  /**
84
91
  * Object model of a site page item.
package/types/sharedTypes/module-factory.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="@types/react" />
1
2
  import { ComponentType } from 'react';
2
3
  import { GetServerSideComponentProps, GetStaticComponentProps } from './component-props';
3
4
  /**