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

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 (30) hide show
  1. package/README.md +1 -4
  2. package/dist/cjs/editing/editing-data-middleware.js +2 -2
  3. package/dist/cjs/editing/editing-data-service.js +7 -15
  4. package/dist/cjs/editing/editing-render-middleware.js +8 -31
  5. package/dist/cjs/index.js +3 -7
  6. package/dist/cjs/services/base-graphql-sitemap-service.js +0 -8
  7. package/dist/esm/editing/editing-data-middleware.js +1 -1
  8. package/dist/esm/editing/editing-data-service.js +5 -13
  9. package/dist/esm/editing/editing-render-middleware.js +8 -31
  10. package/dist/esm/index.js +1 -6
  11. package/dist/esm/services/base-graphql-sitemap-service.js +1 -9
  12. package/package.json +5 -5
  13. package/types/ComponentBuilder.d.ts +0 -1
  14. package/types/components/ComponentPropsContext.d.ts +0 -1
  15. package/types/components/Link.d.ts +0 -1
  16. package/types/components/NextImage.d.ts +0 -1
  17. package/types/components/Placeholder.d.ts +0 -1
  18. package/types/editing/editing-data-service.d.ts +4 -12
  19. package/types/editing/editing-render-middleware.d.ts +0 -10
  20. package/types/index.d.ts +1 -4
  21. package/types/services/base-graphql-sitemap-service.d.ts +3 -10
  22. package/types/sharedTypes/module-factory.d.ts +0 -1
  23. package/dist/cjs/editing/constants.js +0 -6
  24. package/dist/cjs/graphql/index.js +0 -6
  25. package/dist/esm/editing/constants.js +0 -3
  26. package/dist/esm/graphql/index.js +0 -1
  27. package/graphql.d.ts +0 -1
  28. package/graphql.js +0 -1
  29. package/types/editing/constants.d.ts +0 -3
  30. package/types/graphql/index.d.ts +0 -1
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/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 constants_1 = require("./constants");
15
+ const editing_data_service_1 = require("./editing-data-service");
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[constants_1.QUERY_PARAM_EDITING_SECRET];
29
+ const secret = query[editing_data_service_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 = void 0;
13
- const constants_1 = require("./constants");
12
+ exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.generateKey = exports.QUERY_PARAM_EDITING_SECRET = void 0;
14
13
  const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
15
14
  const editing_data_cache_1 = require("./editing-data-cache");
16
15
  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,14 +98,13 @@ 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, params) {
101
+ setEditingData(data, serverUrl) {
102
102
  return __awaiter(this, void 0, void 0, function* () {
103
103
  const key = this.generateKey(data);
104
- const url = this.getUrl(serverUrl, key, params);
104
+ const url = this.getUrl(serverUrl, key);
105
105
  const previewData = {
106
106
  key,
107
107
  serverUrl,
108
- params,
109
108
  };
110
109
  sitecore_jss_1.debug.editing('storing editing data for %o: %o', previewData, data);
111
110
  return this.dataFetcher.put(url, data).then(() => {
@@ -124,27 +123,20 @@ class ServerlessEditingDataService {
124
123
  if (!(editingPreviewData === null || editingPreviewData === void 0 ? void 0 : editingPreviewData.serverUrl)) {
125
124
  return undefined;
126
125
  }
127
- const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key, editingPreviewData.params);
126
+ const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key);
128
127
  sitecore_jss_1.debug.editing('retrieving editing data for %o', previewData);
129
128
  return this.dataFetcher.get(url).then((response) => {
130
129
  return response.data;
131
130
  });
132
131
  });
133
132
  }
134
- getUrl(serverUrl, key, params) {
133
+ getUrl(serverUrl, key) {
135
134
  var _a;
136
135
  // Example URL format:
137
136
  // http://localhost:3000/api/editing/data/52961eea-bafd-5287-a532-a72e36bd8a36-qkb4e3fv5x?secret=1234secret
138
137
  const apiRoute = (_a = this.apiRoute) === null || _a === void 0 ? void 0 : _a.replace('[key]', key);
139
138
  const url = new URL(apiRoute, serverUrl);
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
- }
139
+ url.searchParams.append(exports.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
148
140
  return url.toString();
149
141
  }
150
142
  }
package/dist/cjs/editing/editing-render-middleware.js CHANGED
@@ -15,7 +15,6 @@ 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");
19
18
  const utils_1 = require("../utils/utils");
20
19
  /**
21
20
  * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
@@ -27,21 +26,6 @@ class EditingRenderMiddleware {
27
26
  */
28
27
  constructor(config) {
29
28
  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
- };
45
29
  this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
46
30
  var _e, _f;
47
31
  const { method, query, body, headers } = req;
@@ -60,7 +44,7 @@ class EditingRenderMiddleware {
60
44
  });
61
45
  }
62
46
  // Validate secret
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;
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;
64
48
  if (secret !== (0, utils_1.getJssEditingSecret)()) {
65
49
  sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
66
50
  return res.status(401).json({
@@ -72,28 +56,21 @@ class EditingRenderMiddleware {
72
56
  const editingData = extractEditingData(req);
73
57
  // Resolve server URL
74
58
  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);
77
59
  // Stash for use later on (i.e. within getStatic/ServerSideProps).
78
60
  // Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
79
61
  // https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
80
- const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
62
+ const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
81
63
  // Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
82
64
  res.setPreviewData(previewData);
83
65
  // Grab the Next.js preview cookies to send on to the render request
84
66
  const cookies = res.getHeader('Set-Cookie');
85
- // Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
67
+ // Make actual render request for page route, passing on preview cookies.
86
68
  // 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);
87
70
  sitecore_jss_1.debug.editing('fetching page route for %s', editingData.path);
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());
71
+ const queryStringCharacter = requestUrl.indexOf('?') === -1 ? '?' : '&';
95
72
  const pageRes = yield this.dataFetcher
96
- .get(requestUrl.toString(), {
73
+ .get(`${requestUrl}${queryStringCharacter}timestamp=${Date.now()}`, {
97
74
  headers: {
98
75
  Cookie: cookies.join(';'),
99
76
  },
@@ -108,7 +85,7 @@ class EditingRenderMiddleware {
108
85
  });
109
86
  let html = pageRes.data;
110
87
  if (!html || html.length === 0) {
111
- throw new Error(`Failed to render html for ${editingData.path}`);
88
+ throw new Error(`Failed to render html for ${requestUrl}`);
112
89
  }
113
90
  // replace phkey attribute with key attribute so that newly added renderings
114
91
  // show correct placeholders, so save and refresh won't be needed after adding each rendering
@@ -124,7 +101,7 @@ class EditingRenderMiddleware {
124
101
  // Handle component rendering. Extract component markup only
125
102
  html = (_f = (0, node_html_parser_1.parse)(html).getElementById(layout_1.EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
126
103
  if (!html)
127
- throw new Error(`Failed to render component for ${editingData.path}`);
104
+ throw new Error(`Failed to render component for ${requestUrl}`);
128
105
  }
129
106
  const body = { html };
130
107
  // Return expected JSON result
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.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;
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;
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,7 +33,6 @@ 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");
37
36
  const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
38
37
  const utils_2 = require("./utils");
39
38
  /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
@@ -51,11 +50,6 @@ exports.resolveUrl = resolveUrl;
51
50
  exports.tryParseEnvValue = tryParseEnvValue;
52
51
  exports.handleEditorFastRefresh = handleEditorFastRefresh;
53
52
  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;
59
53
  var layout_1 = require("@sitecore-jss/sitecore-jss/layout");
60
54
  Object.defineProperty(exports, "LayoutServicePageState", { enumerable: true, get: function () { return layout_1.LayoutServicePageState; } });
61
55
  Object.defineProperty(exports, "GraphQLLayoutService", { enumerable: true, get: function () { return layout_1.GraphQLLayoutService; } });
@@ -79,6 +73,8 @@ Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true,
79
73
  Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return personalize_1.normalizePersonalizedRewrite; } });
80
74
  Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return personalize_1.CdpHelper; } });
81
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; } });
82
78
  var component_props_service_1 = require("./services/component-props-service");
83
79
  Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
84
80
  var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
package/dist/cjs/services/base-graphql-sitemap-service.js CHANGED
@@ -195,14 +195,6 @@ 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
- }
206
198
  return new graphql_1.GraphQLRequestClient(this.options.endpoint, {
207
199
  apiKey: this.options.apiKey,
208
200
  debugger: sitecore_jss_1.debug.sitemap,
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 './constants';
12
+ import { QUERY_PARAM_EDITING_SECRET } from './editing-data-service';
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';
11
10
  import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
12
11
  import { editingDataDiskCache } from './editing-data-cache';
13
12
  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,14 +93,13 @@ 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, params) {
96
+ setEditingData(data, serverUrl) {
97
97
  return __awaiter(this, void 0, void 0, function* () {
98
98
  const key = this.generateKey(data);
99
- const url = this.getUrl(serverUrl, key, params);
99
+ const url = this.getUrl(serverUrl, key);
100
100
  const previewData = {
101
101
  key,
102
102
  serverUrl,
103
- params,
104
103
  };
105
104
  debug.editing('storing editing data for %o: %o', previewData, data);
106
105
  return this.dataFetcher.put(url, data).then(() => {
@@ -119,27 +118,20 @@ export class ServerlessEditingDataService {
119
118
  if (!(editingPreviewData === null || editingPreviewData === void 0 ? void 0 : editingPreviewData.serverUrl)) {
120
119
  return undefined;
121
120
  }
122
- const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key, editingPreviewData.params);
121
+ const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key);
123
122
  debug.editing('retrieving editing data for %o', previewData);
124
123
  return this.dataFetcher.get(url).then((response) => {
125
124
  return response.data;
126
125
  });
127
126
  });
128
127
  }
129
- getUrl(serverUrl, key, params) {
128
+ getUrl(serverUrl, key) {
130
129
  var _a;
131
130
  // Example URL format:
132
131
  // http://localhost:3000/api/editing/data/52961eea-bafd-5287-a532-a72e36bd8a36-qkb4e3fv5x?secret=1234secret
133
132
  const apiRoute = (_a = this.apiRoute) === null || _a === void 0 ? void 0 : _a.replace('[key]', key);
134
133
  const url = new URL(apiRoute, serverUrl);
135
134
  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
- }
143
135
  return url.toString();
144
136
  }
145
137
  }
package/dist/esm/editing/editing-render-middleware.js CHANGED
@@ -11,8 +11,7 @@ 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 } from './editing-data-service';
15
- import { QUERY_PARAM_EDITING_SECRET, QUERY_PARAM_PROTECTION_BYPASS_SITECORE, QUERY_PARAM_PROTECTION_BYPASS_VERCEL, } from './constants';
14
+ import { editingDataService, QUERY_PARAM_EDITING_SECRET, } from './editing-data-service';
16
15
  import { getJssEditingSecret } from '../utils/utils';
17
16
  /**
18
17
  * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
@@ -24,21 +23,6 @@ export class EditingRenderMiddleware {
24
23
  */
25
24
  constructor(config) {
26
25
  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
- };
42
26
  this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
43
27
  var _e, _f;
44
28
  const { method, query, body, headers } = req;
@@ -69,28 +53,21 @@ export class EditingRenderMiddleware {
69
53
  const editingData = extractEditingData(req);
70
54
  // Resolve server URL
71
55
  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);
74
56
  // Stash for use later on (i.e. within getStatic/ServerSideProps).
75
57
  // Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
76
58
  // https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
77
- const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
59
+ const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
78
60
  // Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
79
61
  res.setPreviewData(previewData);
80
62
  // Grab the Next.js preview cookies to send on to the render request
81
63
  const cookies = res.getHeader('Set-Cookie');
82
- // Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
64
+ // Make actual render request for page route, passing on preview cookies.
83
65
  // 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);
84
67
  debug.editing('fetching page route for %s', editingData.path);
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());
68
+ const queryStringCharacter = requestUrl.indexOf('?') === -1 ? '?' : '&';
92
69
  const pageRes = yield this.dataFetcher
93
- .get(requestUrl.toString(), {
70
+ .get(`${requestUrl}${queryStringCharacter}timestamp=${Date.now()}`, {
94
71
  headers: {
95
72
  Cookie: cookies.join(';'),
96
73
  },
@@ -105,7 +82,7 @@ export class EditingRenderMiddleware {
105
82
  });
106
83
  let html = pageRes.data;
107
84
  if (!html || html.length === 0) {
108
- throw new Error(`Failed to render html for ${editingData.path}`);
85
+ throw new Error(`Failed to render html for ${requestUrl}`);
109
86
  }
110
87
  // replace phkey attribute with key attribute so that newly added renderings
111
88
  // show correct placeholders, so save and refresh won't be needed after adding each rendering
@@ -121,7 +98,7 @@ export class EditingRenderMiddleware {
121
98
  // Handle component rendering. Extract component markup only
122
99
  html = (_f = parse(html).getElementById(EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
123
100
  if (!html)
124
- throw new Error(`Failed to render component for ${editingData.path}`);
101
+ throw new Error(`Failed to render component for ${requestUrl}`);
125
102
  }
126
103
  const body = { html };
127
104
  // Return expected JSON result
package/dist/esm/index.js CHANGED
@@ -1,7 +1,6 @@
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';
5
4
  import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
6
5
  import { handleEditorFastRefresh as handleEditorFastRefreshDep, getPublicUrl as getPublicUrlDep, } from './utils';
7
6
  /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
@@ -13,11 +12,6 @@ const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChr
13
12
  handleEditorFastRefreshDep,
14
13
  getPublicUrlDep,
15
14
  };
16
- /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
17
- const { GraphQLRequestClientDep: GraphQLRequestClient } = {
18
- GraphQLRequestClientDep,
19
- };
20
- export { GraphQLRequestClient };
21
15
  export { handleEditorFastRefresh, getPublicUrl };
22
16
  export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
23
17
  export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
@@ -25,6 +19,7 @@ export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
25
19
  export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
26
20
  export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
27
21
  export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
22
+ export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
28
23
  export { ComponentPropsService } from './services/component-props-service';
29
24
  export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
30
25
  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,14 +191,6 @@ 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
- }
202
194
  return new GraphQLRequestClient(this.options.endpoint, {
203
195
  apiKey: this.options.apiKey,
204
196
  debugger: debug.sitemap,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore-jss/sitecore-jss-nextjs",
3
- "version": "21.6.0-canary.20",
3
+ "version": "21.6.0-canary.22",
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.20",
76
- "@sitecore-jss/sitecore-jss-dev-tools": "^21.6.0-canary.20",
77
- "@sitecore-jss/sitecore-jss-react": "^21.6.0-canary.20",
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",
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": "4dbea23c00eacc9047923277766a63075e3be26b",
86
+ "gitHead": "4f902b49bd406cec630749bb1b192c3e3370a0a3",
87
87
  "files": [
88
88
  "dist",
89
89
  "types",
package/types/ComponentBuilder.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="@types/react" />
2
1
  import { ComponentFactory } from '@sitecore-jss/sitecore-jss-react';
3
2
  import { Module, ModuleFactory } from './sharedTypes/module-factory';
4
3
  import { ComponentType } from 'react';
package/types/components/ComponentPropsContext.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="@types/react" />
2
1
  import React, { ReactNode } from 'react';
3
2
  import { ComponentPropsCollection } from '../sharedTypes/component-props';
4
3
  /**
package/types/components/Link.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="@types/react" />
2
1
  import React from 'react';
3
2
  import { LinkProps as ReactLinkProps } from '@sitecore-jss/sitecore-jss-react';
4
3
  export type LinkProps = ReactLinkProps & {
package/types/components/NextImage.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="@types/react" />
2
1
  import React from 'react';
3
2
  import { ImageProps } from '@sitecore-jss/sitecore-jss-react';
4
3
  import { ImageLoader, ImageProps as NextImageProperties } from 'next/image';
package/types/components/Placeholder.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="@types/react" />
2
1
  import React from 'react';
3
2
  import { PlaceholderComponentProps } from '@sitecore-jss/sitecore-jss-react';
4
3
  export declare const Placeholder: (props: PlaceholderComponentProps) => React.JSX.Element;
package/types/editing/editing-data-service.d.ts CHANGED
@@ -2,15 +2,13 @@ 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";
5
6
  /**
6
7
  * Data for Next.js Preview (Editing) mode
7
8
  */
8
9
  export interface EditingPreviewData {
9
10
  key: string;
10
11
  serverUrl?: string;
11
- params?: {
12
- [key: string]: string;
13
- };
14
12
  }
15
13
  /**
16
14
  * Defines an editing data service implementation
@@ -22,9 +20,7 @@ export interface EditingDataService {
22
20
  * @param {string} serverUrl The server url e.g. which can be used for further API requests
23
21
  * @returns The {@link EditingPreviewData} containing the information to use for retrieval
24
22
  */
25
- setEditingData(data: EditingData, serverUrl: string, params?: {
26
- [key: string]: string;
27
- }): Promise<EditingPreviewData>;
23
+ setEditingData(data: EditingData, serverUrl: string): Promise<EditingPreviewData>;
28
24
  /**
29
25
  * Retrieves Sitecore editor payload data
30
26
  * @param {PreviewData} previewData Editing preview data containing the information to use for retrieval
@@ -111,18 +107,14 @@ export declare class ServerlessEditingDataService implements EditingDataService
111
107
  * @param {string} serverUrl The server url to use for subsequent data API requests
112
108
  * @returns {Promise} The {@link EditingPreviewData} containing the generated key and serverUrl to use for retrieval
113
109
  */
114
- setEditingData(data: EditingData, serverUrl: string, params?: {
115
- [key: string]: string;
116
- }): Promise<EditingPreviewData>;
110
+ setEditingData(data: EditingData, serverUrl: string): Promise<EditingPreviewData>;
117
111
  /**
118
112
  * Retrieves Sitecore editor payload data by key
119
113
  * @param {PreviewData} previewData Editing preview data containing the key and serverUrl to use for retrieval
120
114
  * @returns {Promise} The {@link EditingData}
121
115
  */
122
116
  getEditingData(previewData: PreviewData): Promise<EditingData | undefined>;
123
- protected getUrl(serverUrl: string, key: string, params?: {
124
- [key: string]: string;
125
- }): string;
117
+ protected getUrl(serverUrl: string, key: string): string;
126
118
  }
127
119
  /**
128
120
  * The `EditingDataService` default instance.
package/types/editing/editing-render-middleware.d.ts CHANGED
@@ -55,16 +55,6 @@ 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
- };
68
58
  private handler;
69
59
  /**
70
60
  * Default page URL resolution.
package/types/index.d.ts CHANGED
@@ -1,11 +1,7 @@
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';
3
2
  import { resolveUrl as resolveUrlDep } from '@sitecore-jss/sitecore-jss/utils';
4
3
  /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
5
4
  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 };
9
5
  export { handleEditorFastRefresh, getPublicUrl };
10
6
  export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
11
7
  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';
@@ -13,6 +9,7 @@ export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
13
9
  export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
14
10
  export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
15
11
  export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
12
+ export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
16
13
  export { ComponentPropsCollection, ComponentPropsError, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
17
14
  export { ModuleFactory, Module } from './sharedTypes/module-factory';
18
15
  export { ComponentPropsService } from './services/component-props-service';
package/types/services/base-graphql-sitemap-service.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { GraphQLClient, GraphQLRequestClientFactory, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
1
+ import { GraphQLClient, 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,24 +68,17 @@ 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
72
71
  */
73
- endpoint?: string;
72
+ endpoint: string;
74
73
  /**
75
74
  * The API key to use for authentication.
76
- * @deprecated use @param clientFactory property instead
77
75
  */
78
- apiKey?: string;
76
+ apiKey: string;
79
77
  /**
80
78
  * A flag for whether to include personalized routes in service output - only works on XM Cloud
81
79
  * turned off by default
82
80
  */
83
81
  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;
89
82
  }
90
83
  /**
91
84
  * Object model of a site page item.
package/types/sharedTypes/module-factory.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="@types/react" />
2
1
  import { ComponentType } from 'react';
3
2
  import { GetServerSideComponentProps, GetStaticComponentProps } from './component-props';
4
3
  /**
package/dist/cjs/editing/constants.js DELETED
@@ -1,6 +0,0 @@
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/graphql/index.js DELETED
@@ -1,6 +0,0 @@
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/esm/editing/constants.js DELETED
@@ -1,3 +0,0 @@
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/graphql/index.js DELETED
@@ -1 +0,0 @@
1
- export { GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
package/graphql.d.ts DELETED
@@ -1 +0,0 @@
1
- export * from './types/graphql/index';
package/graphql.js DELETED
@@ -1 +0,0 @@
1
- module.exports = require('./dist/cjs/graphql/index');
package/types/editing/constants.d.ts DELETED
@@ -1,3 +0,0 @@
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/graphql/index.d.ts DELETED
@@ -1 +0,0 @@
1
- export { GraphQLRequestClient, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';