@sitecore-jss/sitecore-jss-nextjs 21.4.0-canary.1 → 21.4.0-canary.10

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 (31) hide show
  1. package/README.md +0 -3
  2. package/dist/cjs/ComponentBuilder.js +1 -3
  3. package/dist/cjs/editing/editing-render-middleware.js +1 -5
  4. package/dist/cjs/editing/index.js +1 -3
  5. package/dist/cjs/index.js +2 -31
  6. package/dist/cjs/middleware/index.js +1 -3
  7. package/dist/cjs/middleware/multisite-middleware.js +1 -2
  8. package/dist/cjs/middleware/personalize-middleware.js +2 -6
  9. package/dist/cjs/middleware/redirects-middleware.js +1 -2
  10. package/dist/cjs/services/component-props-service.js +2 -2
  11. package/dist/esm/ComponentBuilder.js +1 -3
  12. package/dist/esm/editing/editing-render-middleware.js +1 -5
  13. package/dist/esm/editing/index.js +0 -1
  14. package/dist/esm/index.js +2 -4
  15. package/dist/esm/middleware/index.js +0 -1
  16. package/dist/esm/middleware/multisite-middleware.js +1 -2
  17. package/dist/esm/middleware/personalize-middleware.js +2 -6
  18. package/dist/esm/middleware/redirects-middleware.js +1 -2
  19. package/dist/esm/services/component-props-service.js +2 -2
  20. package/package.json +5 -6
  21. package/types/ComponentBuilder.d.ts +1 -1
  22. package/types/editing/index.d.ts +0 -1
  23. package/types/index.d.ts +3 -5
  24. package/types/middleware/index.d.ts +0 -1
  25. package/types/sharedTypes/component-props.d.ts +1 -5
  26. package/dist/cjs/components/FEaaSWrapper.js +0 -49
  27. package/dist/cjs/editing/vercel-editing-data-cache.js +0 -48
  28. package/dist/esm/components/FEaaSWrapper.js +0 -44
  29. package/dist/esm/editing/vercel-editing-data-cache.js +0 -44
  30. package/types/components/FEaaSWrapper.d.ts +0 -21
  31. package/types/editing/vercel-editing-data-cache.d.ts +0 -19
package/README.md CHANGED
@@ -2,9 +2,6 @@
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)
@@ -54,9 +54,7 @@ class ComponentBuilder {
54
54
  if (exportName && exportName !== this.DEFAULT_EXPORT_NAME) {
55
55
  return component[exportName];
56
56
  }
57
- return (component.Default ||
58
- component.default ||
59
- component);
57
+ return component.Default || component.default || null;
60
58
  };
61
59
  }
62
60
  }
@@ -29,7 +29,6 @@ class EditingRenderMiddleware {
29
29
  this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
30
30
  var _e, _f;
31
31
  const { method, query, body, headers } = req;
32
- const startTimestamp = Date.now();
33
32
  sitecore_jss_1.debug.editing('editing render middleware start: %o', {
34
33
  method,
35
34
  query,
@@ -105,10 +104,7 @@ class EditingRenderMiddleware {
105
104
  }
106
105
  const body = { html };
107
106
  // Return expected JSON result
108
- sitecore_jss_1.debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
109
- status: 200,
110
- body,
111
- });
107
+ sitecore_jss_1.debug.editing('editing render middleware end: %o', { status: 200, body });
112
108
  res.status(200).json(body);
113
109
  }
114
110
  catch (err) {
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.VercelEditingDataCache = exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = void 0;
3
+ exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = void 0;
4
4
  var editing_data_cache_1 = require("./editing-data-cache");
5
5
  Object.defineProperty(exports, "EditingDataDiskCache", { enumerable: true, get: function () { return editing_data_cache_1.EditingDataDiskCache; } });
6
6
  var editing_data_middleware_1 = require("./editing-data-middleware");
@@ -11,5 +11,3 @@ var editing_data_service_1 = require("./editing-data-service");
11
11
  Object.defineProperty(exports, "BasicEditingDataService", { enumerable: true, get: function () { return editing_data_service_1.BasicEditingDataService; } });
12
12
  Object.defineProperty(exports, "ServerlessEditingDataService", { enumerable: true, get: function () { return editing_data_service_1.ServerlessEditingDataService; } });
13
13
  Object.defineProperty(exports, "editingDataService", { enumerable: true, get: function () { return editing_data_service_1.editingDataService; } });
14
- var vercel_editing_data_cache_1 = require("./vercel-editing-data-cache");
15
- Object.defineProperty(exports, "VercelEditingDataCache", { enumerable: true, get: function () { return vercel_editing_data_cache_1.VercelEditingDataCache; } });
package/dist/cjs/index.js CHANGED
@@ -1,36 +1,12 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
2
  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;
27
- exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.BYOCWrapper = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.FEaaSWrapper = void 0;
3
+ exports.ComponentBuilder = 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.enableDebug = exports.NativeDataFetcher = exports.AxiosDataFetcher = exports.constants = void 0;
4
+ exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = void 0;
28
5
  var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
29
6
  Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
30
7
  Object.defineProperty(exports, "AxiosDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.AxiosDataFetcher; } });
31
8
  Object.defineProperty(exports, "NativeDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.NativeDataFetcher; } });
32
9
  Object.defineProperty(exports, "enableDebug", { enumerable: true, get: function () { return sitecore_jss_1.enableDebug; } });
33
- Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
34
10
  // we will remove the root exports for these later
35
11
  // we cannot mark exports as deprected directly, so we're using this hack instead
36
12
  const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
@@ -106,8 +82,6 @@ var EditingComponentPlaceholder_1 = require("./components/EditingComponentPlaceh
106
82
  Object.defineProperty(exports, "EditingComponentPlaceholder", { enumerable: true, get: function () { return EditingComponentPlaceholder_1.EditingComponentPlaceholder; } });
107
83
  var NextImage_1 = require("./components/NextImage");
108
84
  Object.defineProperty(exports, "NextImage", { enumerable: true, get: function () { return NextImage_1.NextImage; } });
109
- const FEaaSWrapper = __importStar(require("./components/FEaaSWrapper"));
110
- exports.FEaaSWrapper = FEaaSWrapper;
111
85
  var ComponentBuilder_1 = require("./ComponentBuilder");
112
86
  Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
113
87
  var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
@@ -117,9 +91,6 @@ Object.defineProperty(exports, "DateField", { enumerable: true, get: function ()
117
91
  Object.defineProperty(exports, "EditFrame", { enumerable: true, get: function () { return sitecore_jss_react_1.EditFrame; } });
118
92
  Object.defineProperty(exports, "FEaaSComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.FEaaSComponent; } });
119
93
  Object.defineProperty(exports, "fetchFEaaSComponentServerProps", { enumerable: true, get: function () { return sitecore_jss_react_1.fetchFEaaSComponentServerProps; } });
120
- Object.defineProperty(exports, "BYOCComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCComponent; } });
121
- Object.defineProperty(exports, "getFEAASLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getFEAASLibraryStylesheetLinks; } });
122
- Object.defineProperty(exports, "BYOCWrapper", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCWrapper; } });
123
94
  Object.defineProperty(exports, "File", { enumerable: true, get: function () { return sitecore_jss_react_1.File; } });
124
95
  Object.defineProperty(exports, "VisitorIdentification", { enumerable: true, get: function () { return sitecore_jss_react_1.VisitorIdentification; } });
125
96
  Object.defineProperty(exports, "SitecoreContext", { enumerable: true, get: function () { return sitecore_jss_react_1.SitecoreContext; } });
@@ -1,8 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MultisiteMiddleware = exports.PersonalizeMiddleware = exports.RedirectsMiddleware = exports.debug = void 0;
4
- var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
5
- Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
3
+ exports.MultisiteMiddleware = exports.PersonalizeMiddleware = exports.RedirectsMiddleware = void 0;
6
4
  var redirects_middleware_1 = require("./redirects-middleware");
7
5
  Object.defineProperty(exports, "RedirectsMiddleware", { enumerable: true, get: function () { return redirects_middleware_1.RedirectsMiddleware; } });
8
6
  var personalize_middleware_1 = require("./personalize-middleware");
@@ -29,7 +29,6 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
29
29
  const pathname = req.nextUrl.pathname;
30
30
  const language = this.getLanguage(req);
31
31
  const hostname = this.getHostHeader(req) || this.defaultHostname;
32
- const startTimestamp = Date.now();
33
32
  sitecore_jss_1.debug.multisite('multisite middleware start: %o', {
34
33
  pathname,
35
34
  language,
@@ -59,7 +58,7 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
59
58
  response.cookies.set(this.SITE_SYMBOL, siteName);
60
59
  // Share rewrite path with following executed middlewares
61
60
  response.headers.set('x-sc-rewrite', rewritePath);
62
- sitecore_jss_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
61
+ sitecore_jss_1.debug.multisite('multisite middleware end: %o', {
63
62
  rewritePath,
64
63
  siteName,
65
64
  headers: this.extractDebugHeaders(response.headers),
@@ -28,7 +28,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
28
28
  const pathname = req.nextUrl.pathname;
29
29
  const language = this.getLanguage(req);
30
30
  const hostname = this.getHostHeader(req) || this.defaultHostname;
31
- const startTimestamp = Date.now();
32
31
  let browserId = this.getBrowserId(req);
33
32
  sitecore_jss_1.debug.personalize('personalize middleware start: %o', {
34
33
  pathname,
@@ -99,7 +98,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
99
98
  this.setBrowserId(response, browserId);
100
99
  // Share site name with the following executed middlewares
101
100
  response.cookies.set(this.SITE_SYMBOL, site.name);
102
- sitecore_jss_1.debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
101
+ sitecore_jss_1.debug.personalize('personalize middleware end: %o', {
103
102
  rewritePath,
104
103
  browserId,
105
104
  headers: this.extractDebugHeaders(response.headers),
@@ -150,10 +149,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
150
149
  }
151
150
  getExperienceParams(req) {
152
151
  return {
153
- // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
154
- // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
155
- // used as a fallback
156
- referrer: req.headers.get('referer') || req.referrer,
152
+ referrer: req.referrer,
157
153
  utm: {
158
154
  campaign: req.nextUrl.searchParams.get('utm_campaign'),
159
155
  content: req.nextUrl.searchParams.get('utm_content'),
@@ -35,7 +35,6 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
35
35
  const language = this.getLanguage(req);
36
36
  const hostname = this.getHostHeader(req) || this.defaultHostname;
37
37
  let site;
38
- const startTimestamp = Date.now();
39
38
  sitecore_jss_1.debug.redirects('redirects middleware start: %o', {
40
39
  pathname,
41
40
  language,
@@ -95,7 +94,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
95
94
  // Share site name with the following executed middlewares
96
95
  // Don't need to set when middleware is disabled
97
96
  site && response.cookies.set(this.SITE_SYMBOL, site.name);
98
- sitecore_jss_1.debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
97
+ sitecore_jss_1.debug.redirects('redirects middleware end: %o', {
99
98
  redirected: response.redirected,
100
99
  status: response.status,
101
100
  url: response.url,
@@ -128,11 +128,11 @@ class ComponentPropsService {
128
128
  componentProps[uid] = result;
129
129
  })
130
130
  .catch((error) => {
131
- const errLog = `Error during preload data for component ${req.rendering.componentName} (${uid}): ${error.message || error}`;
131
+ const errLog = `Error during preload data for component ${uid}: ${error.message ||
132
+ error}`;
132
133
  console.error(chalk_1.default.red(errLog));
133
134
  componentProps[uid] = {
134
135
  error: error.message || errLog,
135
- componentName: req.rendering.componentName,
136
136
  };
137
137
  });
138
138
  });
@@ -51,9 +51,7 @@ export class ComponentBuilder {
51
51
  if (exportName && exportName !== this.DEFAULT_EXPORT_NAME) {
52
52
  return component[exportName];
53
53
  }
54
- return (component.Default ||
55
- component.default ||
56
- component);
54
+ return component.Default || component.default || null;
57
55
  };
58
56
  }
59
57
  }
@@ -26,7 +26,6 @@ export class EditingRenderMiddleware {
26
26
  this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
27
27
  var _e, _f;
28
28
  const { method, query, body, headers } = req;
29
- const startTimestamp = Date.now();
30
29
  debug.editing('editing render middleware start: %o', {
31
30
  method,
32
31
  query,
@@ -102,10 +101,7 @@ export class EditingRenderMiddleware {
102
101
  }
103
102
  const body = { html };
104
103
  // Return expected JSON result
105
- debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
106
- status: 200,
107
- body,
108
- });
104
+ debug.editing('editing render middleware end: %o', { status: 200, body });
109
105
  res.status(200).json(body);
110
106
  }
111
107
  catch (err) {
@@ -2,4 +2,3 @@ export { EditingDataDiskCache } from './editing-data-cache';
2
2
  export { EditingDataMiddleware } from './editing-data-middleware';
3
3
  export { EditingRenderMiddleware, } from './editing-render-middleware';
4
4
  export { BasicEditingDataService, ServerlessEditingDataService, editingDataService, } from './editing-data-service';
5
- export { VercelEditingDataCache } from './vercel-editing-data-cache';
package/dist/esm/index.js CHANGED
@@ -1,4 +1,4 @@
1
- export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
1
+ export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, } 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
4
  import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
@@ -31,7 +31,5 @@ export { RichText } from './components/RichText';
31
31
  export { Placeholder } from './components/Placeholder';
32
32
  export { EditingComponentPlaceholder } from './components/EditingComponentPlaceholder';
33
33
  export { NextImage } from './components/NextImage';
34
- import * as FEaaSWrapper from './components/FEaaSWrapper';
35
- export { FEaaSWrapper };
36
34
  export { ComponentBuilder } from './ComponentBuilder';
37
- export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, BYOCWrapper, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
35
+ export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
@@ -1,4 +1,3 @@
1
- export { debug } from '@sitecore-jss/sitecore-jss';
2
1
  export { RedirectsMiddleware } from './redirects-middleware';
3
2
  export { PersonalizeMiddleware } from './personalize-middleware';
4
3
  export { MultisiteMiddleware } from './multisite-middleware';
@@ -26,7 +26,6 @@ export class MultisiteMiddleware extends MiddlewareBase {
26
26
  const pathname = req.nextUrl.pathname;
27
27
  const language = this.getLanguage(req);
28
28
  const hostname = this.getHostHeader(req) || this.defaultHostname;
29
- const startTimestamp = Date.now();
30
29
  debug.multisite('multisite middleware start: %o', {
31
30
  pathname,
32
31
  language,
@@ -56,7 +55,7 @@ export class MultisiteMiddleware extends MiddlewareBase {
56
55
  response.cookies.set(this.SITE_SYMBOL, siteName);
57
56
  // Share rewrite path with following executed middlewares
58
57
  response.headers.set('x-sc-rewrite', rewritePath);
59
- debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
58
+ debug.multisite('multisite middleware end: %o', {
60
59
  rewritePath,
61
60
  siteName,
62
61
  headers: this.extractDebugHeaders(response.headers),
@@ -25,7 +25,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
25
25
  const pathname = req.nextUrl.pathname;
26
26
  const language = this.getLanguage(req);
27
27
  const hostname = this.getHostHeader(req) || this.defaultHostname;
28
- const startTimestamp = Date.now();
29
28
  let browserId = this.getBrowserId(req);
30
29
  debug.personalize('personalize middleware start: %o', {
31
30
  pathname,
@@ -96,7 +95,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
96
95
  this.setBrowserId(response, browserId);
97
96
  // Share site name with the following executed middlewares
98
97
  response.cookies.set(this.SITE_SYMBOL, site.name);
99
- debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
98
+ debug.personalize('personalize middleware end: %o', {
100
99
  rewritePath,
101
100
  browserId,
102
101
  headers: this.extractDebugHeaders(response.headers),
@@ -147,10 +146,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
147
146
  }
148
147
  getExperienceParams(req) {
149
148
  return {
150
- // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
151
- // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
152
- // used as a fallback
153
- referrer: req.headers.get('referer') || req.referrer,
149
+ referrer: req.referrer,
154
150
  utm: {
155
151
  campaign: req.nextUrl.searchParams.get('utm_campaign'),
156
152
  content: req.nextUrl.searchParams.get('utm_content'),
@@ -29,7 +29,6 @@ export class RedirectsMiddleware extends MiddlewareBase {
29
29
  const language = this.getLanguage(req);
30
30
  const hostname = this.getHostHeader(req) || this.defaultHostname;
31
31
  let site;
32
- const startTimestamp = Date.now();
33
32
  debug.redirects('redirects middleware start: %o', {
34
33
  pathname,
35
34
  language,
@@ -89,7 +88,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
89
88
  // Share site name with the following executed middlewares
90
89
  // Don't need to set when middleware is disabled
91
90
  site && response.cookies.set(this.SITE_SYMBOL, site.name);
92
- debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
91
+ debug.redirects('redirects middleware end: %o', {
93
92
  redirected: response.redirected,
94
93
  status: response.status,
95
94
  url: response.url,
@@ -122,11 +122,11 @@ export class ComponentPropsService {
122
122
  componentProps[uid] = result;
123
123
  })
124
124
  .catch((error) => {
125
- const errLog = `Error during preload data for component ${req.rendering.componentName} (${uid}): ${error.message || error}`;
125
+ const errLog = `Error during preload data for component ${uid}: ${error.message ||
126
+ error}`;
126
127
  console.error(chalk.red(errLog));
127
128
  componentProps[uid] = {
128
129
  error: error.message || errLog,
129
- componentName: req.rendering.componentName,
130
130
  };
131
131
  });
132
132
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore-jss/sitecore-jss-nextjs",
3
- "version": "21.4.0-canary.1",
3
+ "version": "21.4.0-canary.10",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "sideEffects": false,
@@ -70,10 +70,9 @@
70
70
  "react-dom": "^18.2.0"
71
71
  },
72
72
  "dependencies": {
73
- "@sitecore-jss/sitecore-jss": "^21.4.0-canary.1",
74
- "@sitecore-jss/sitecore-jss-dev-tools": "^21.4.0-canary.1",
75
- "@sitecore-jss/sitecore-jss-react": "^21.4.0-canary.1",
76
- "@vercel/kv": "^0.2.1",
73
+ "@sitecore-jss/sitecore-jss": "^21.4.0-canary.10",
74
+ "@sitecore-jss/sitecore-jss-dev-tools": "^21.4.0-canary.10",
75
+ "@sitecore-jss/sitecore-jss-react": "^21.4.0-canary.10",
77
76
  "node-html-parser": "^6.1.4",
78
77
  "prop-types": "^15.8.1",
79
78
  "regex-parser": "^2.2.11",
@@ -81,7 +80,7 @@
81
80
  },
82
81
  "description": "",
83
82
  "types": "types/index.d.ts",
84
- "gitHead": "ba19b0377facf496ea5f5cbe31f724fa3fb26ebf",
83
+ "gitHead": "f0d7b8f28bd068b3342afa61f5226386fa7dff7c",
85
84
  "files": [
86
85
  "dist",
87
86
  "types",
@@ -11,7 +11,7 @@ export type LazyModule = {
11
11
  /**
12
12
  * Component is a module or a lazy module
13
13
  */
14
- type Component = Module | LazyModule | ComponentType;
14
+ type Component = Module | LazyModule;
15
15
  /**
16
16
  * Configuration for ComponentBuilder
17
17
  */
@@ -3,4 +3,3 @@ export { EditingDataCache, EditingDataDiskCache } from './editing-data-cache';
3
3
  export { EditingDataMiddleware, EditingDataMiddlewareConfig } from './editing-data-middleware';
4
4
  export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, } from './editing-render-middleware';
5
5
  export { EditingPreviewData, EditingDataService, BasicEditingDataService, BasicEditingDataServiceConfig, ServerlessEditingDataService, ServerlessEditingDataServiceConfig, editingDataService, } from './editing-data-service';
6
- export { VercelEditingDataCache } from './vercel-editing-data-cache';
package/types/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
1
+ export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, } from '@sitecore-jss/sitecore-jss';
2
2
  import { resolveUrl as resolveUrlDep } from '@sitecore-jss/sitecore-jss/utils';
3
3
  /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
4
4
  declare const isEditorActive: () => boolean, resetEditorChromes: () => void, resolveUrl: typeof resolveUrlDep, tryParseEnvValue: <T>(envValue: string | undefined, defaultValue: T) => T, handleEditorFastRefresh: (forceReload?: boolean) => void, getPublicUrl: () => string;
@@ -10,7 +10,7 @@ export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, Ou
10
10
  export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
11
11
  export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
12
12
  export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
13
- export { ComponentPropsCollection, ComponentPropsError, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
13
+ export { ComponentPropsCollection, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
14
14
  export { ModuleFactory, Module } from './sharedTypes/module-factory';
15
15
  export { ComponentPropsService } from './services/component-props-service';
16
16
  export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
@@ -24,7 +24,5 @@ export { RichText, RichTextProps } from './components/RichText';
24
24
  export { Placeholder } from './components/Placeholder';
25
25
  export { EditingComponentPlaceholder } from './components/EditingComponentPlaceholder';
26
26
  export { NextImage } from './components/NextImage';
27
- import * as FEaaSWrapper from './components/FEaaSWrapper';
28
- export { FEaaSWrapper };
29
27
  export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
30
- export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getFEAASLibraryStylesheetLinks, BYOCWrapper, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';
28
+ export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';
@@ -1,4 +1,3 @@
1
- export { debug } from '@sitecore-jss/sitecore-jss';
2
1
  export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
3
2
  export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
4
3
  export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';
@@ -1,14 +1,10 @@
1
1
  import { GetServerSidePropsContext, GetStaticPropsContext } from 'next';
2
2
  import { ComponentRendering, LayoutServiceData } from '@sitecore-jss/sitecore-jss/layout';
3
- export type ComponentPropsError = {
4
- error: string;
5
- componentName: string;
6
- };
7
3
  /**
8
4
  * Shape of component props storage
9
5
  */
10
6
  export type ComponentPropsCollection = {
11
- [componentUid: string]: unknown | ComponentPropsError;
7
+ [componentUid: string]: unknown;
12
8
  };
13
9
  /**
14
10
  * Type of side effect function which could be invoked on component level (getStaticProps/getServerSideProps)
@@ -1,49 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.getServerSideProps = exports.getStaticProps = void 0;
13
- const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
14
- const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
15
- /**
16
- * This is a repackaged version of the React FEaaSWrapper component with support for
17
- * server rendering in Next.js (using component-level data-fetching feature of JSS).
18
- */
19
- /**
20
- * Will be called during SSG
21
- * @param {ComponentRendering} rendering
22
- * @param {LayoutServiceData} layoutData
23
- * @returns {GetStaticPropsContext} context
24
- */
25
- const getStaticProps = (rendering, layoutData) => __awaiter(void 0, void 0, void 0, function* () {
26
- if (process.env.JSS_MODE === sitecore_jss_1.constants.JSS_MODE.DISCONNECTED) {
27
- return null;
28
- }
29
- const params = rendering.params || {};
30
- const result = yield (0, sitecore_jss_react_1.fetchFEaaSComponentServerProps)(params, layoutData.sitecore.context.pageState);
31
- return result;
32
- });
33
- exports.getStaticProps = getStaticProps;
34
- /**
35
- * Will be called during SSR
36
- * @param {ComponentRendering} rendering
37
- * @param {LayoutServiceData} layoutData
38
- * @returns {GetStaticPropsContext} context
39
- */
40
- const getServerSideProps = (rendering, layoutData) => __awaiter(void 0, void 0, void 0, function* () {
41
- if (process.env.JSS_MODE === sitecore_jss_1.constants.JSS_MODE.DISCONNECTED) {
42
- return null;
43
- }
44
- const params = rendering.params || {};
45
- const result = yield (0, sitecore_jss_react_1.fetchFEaaSComponentServerProps)(params, layoutData.sitecore.context.pageState);
46
- return result;
47
- });
48
- exports.getServerSideProps = getServerSideProps;
49
- exports.default = sitecore_jss_react_1.FEaaSWrapper;
@@ -1,48 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.VercelEditingDataCache = void 0;
4
- const kv_1 = require("@vercel/kv");
5
- const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
6
- /**
7
- * Implementation of editing cache for Vercel deployments
8
- * Uses Vercel KV database and client to store data
9
- * Set TTL for cache data in constructor (default: 60 seconds)
10
- */
11
- class VercelEditingDataCache {
12
- /**
13
- * @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
14
- * @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
15
- */
16
- constructor(redisUrl, redisToken) {
17
- this.defaultTtl = 120;
18
- if (!redisUrl || !redisToken) {
19
- throw Error('API URL or token are missing, ensure you have set the KV or Upstash storage correctly.');
20
- }
21
- this.redisCache = (0, kv_1.createClient)({
22
- url: redisUrl,
23
- token: redisToken,
24
- });
25
- }
26
- set(key, editingData) {
27
- sitecore_jss_1.debug.editing(`Putting editing data for ${key} into redis storage...`);
28
- return new Promise((resolve, reject) => {
29
- this.redisCache
30
- .set(key, JSON.stringify(editingData), { ex: this.defaultTtl })
31
- .then(() => resolve())
32
- .catch((err) => reject(err));
33
- });
34
- }
35
- get(key) {
36
- sitecore_jss_1.debug.editing(`Getting editing data for ${key} from redis storage...`);
37
- return new Promise((resolve, reject) => {
38
- this.redisCache
39
- .get(key)
40
- .then((entry) => {
41
- const result = (entry || undefined);
42
- this.redisCache.expire(key, 0).then(() => resolve(result));
43
- })
44
- .catch((err) => reject(err));
45
- });
46
- }
47
- }
48
- exports.VercelEditingDataCache = VercelEditingDataCache;
@@ -1,44 +0,0 @@
1
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
- return new (P || (P = Promise))(function (resolve, reject) {
4
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
- step((generator = generator.apply(thisArg, _arguments || [])).next());
8
- });
9
- };
10
- import { FEaaSWrapper, fetchFEaaSComponentServerProps, } from '@sitecore-jss/sitecore-jss-react';
11
- import { constants } from '@sitecore-jss/sitecore-jss';
12
- /**
13
- * This is a repackaged version of the React FEaaSWrapper component with support for
14
- * server rendering in Next.js (using component-level data-fetching feature of JSS).
15
- */
16
- /**
17
- * Will be called during SSG
18
- * @param {ComponentRendering} rendering
19
- * @param {LayoutServiceData} layoutData
20
- * @returns {GetStaticPropsContext} context
21
- */
22
- export const getStaticProps = (rendering, layoutData) => __awaiter(void 0, void 0, void 0, function* () {
23
- if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
24
- return null;
25
- }
26
- const params = rendering.params || {};
27
- const result = yield fetchFEaaSComponentServerProps(params, layoutData.sitecore.context.pageState);
28
- return result;
29
- });
30
- /**
31
- * Will be called during SSR
32
- * @param {ComponentRendering} rendering
33
- * @param {LayoutServiceData} layoutData
34
- * @returns {GetStaticPropsContext} context
35
- */
36
- export const getServerSideProps = (rendering, layoutData) => __awaiter(void 0, void 0, void 0, function* () {
37
- if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
38
- return null;
39
- }
40
- const params = rendering.params || {};
41
- const result = yield fetchFEaaSComponentServerProps(params, layoutData.sitecore.context.pageState);
42
- return result;
43
- });
44
- export default FEaaSWrapper;
@@ -1,44 +0,0 @@
1
- import { createClient } from '@vercel/kv';
2
- import { debug } from '@sitecore-jss/sitecore-jss';
3
- /**
4
- * Implementation of editing cache for Vercel deployments
5
- * Uses Vercel KV database and client to store data
6
- * Set TTL for cache data in constructor (default: 60 seconds)
7
- */
8
- export class VercelEditingDataCache {
9
- /**
10
- * @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
11
- * @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
12
- */
13
- constructor(redisUrl, redisToken) {
14
- this.defaultTtl = 120;
15
- if (!redisUrl || !redisToken) {
16
- throw Error('API URL or token are missing, ensure you have set the KV or Upstash storage correctly.');
17
- }
18
- this.redisCache = createClient({
19
- url: redisUrl,
20
- token: redisToken,
21
- });
22
- }
23
- set(key, editingData) {
24
- debug.editing(`Putting editing data for ${key} into redis storage...`);
25
- return new Promise((resolve, reject) => {
26
- this.redisCache
27
- .set(key, JSON.stringify(editingData), { ex: this.defaultTtl })
28
- .then(() => resolve())
29
- .catch((err) => reject(err));
30
- });
31
- }
32
- get(key) {
33
- debug.editing(`Getting editing data for ${key} from redis storage...`);
34
- return new Promise((resolve, reject) => {
35
- this.redisCache
36
- .get(key)
37
- .then((entry) => {
38
- const result = (entry || undefined);
39
- this.redisCache.expire(key, 0).then(() => resolve(result));
40
- })
41
- .catch((err) => reject(err));
42
- });
43
- }
44
- }
@@ -1,21 +0,0 @@
1
- import { FEaaSWrapper } from '@sitecore-jss/sitecore-jss-react';
2
- import { GetStaticComponentProps, GetServerSideComponentProps } from '../sharedTypes/component-props';
3
- /**
4
- * This is a repackaged version of the React FEaaSWrapper component with support for
5
- * server rendering in Next.js (using component-level data-fetching feature of JSS).
6
- */
7
- /**
8
- * Will be called during SSG
9
- * @param {ComponentRendering} rendering
10
- * @param {LayoutServiceData} layoutData
11
- * @returns {GetStaticPropsContext} context
12
- */
13
- export declare const getStaticProps: GetStaticComponentProps;
14
- /**
15
- * Will be called during SSR
16
- * @param {ComponentRendering} rendering
17
- * @param {LayoutServiceData} layoutData
18
- * @returns {GetStaticPropsContext} context
19
- */
20
- export declare const getServerSideProps: GetServerSideComponentProps;
21
- export default FEaaSWrapper;
@@ -1,19 +0,0 @@
1
- import { VercelKV } from '@vercel/kv';
2
- import { EditingDataCache } from './editing-data-cache';
3
- import { EditingData } from './editing-data';
4
- /**
5
- * Implementation of editing cache for Vercel deployments
6
- * Uses Vercel KV database and client to store data
7
- * Set TTL for cache data in constructor (default: 60 seconds)
8
- */
9
- export declare class VercelEditingDataCache implements EditingDataCache {
10
- protected redisCache: VercelKV;
11
- private defaultTtl;
12
- /**
13
- * @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
14
- * @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
15
- */
16
- constructor(redisUrl: string | undefined, redisToken: string | undefined);
17
- set(key: string, editingData: EditingData): Promise<void>;
18
- get(key: string): Promise<EditingData | undefined>;
19
- }