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

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 (39) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/ComponentBuilder.js +3 -1
  3. package/dist/cjs/components/BYOCWrapper.js +47 -0
  4. package/dist/cjs/components/FEaaSWrapper.js +49 -0
  5. package/dist/cjs/editing/editing-render-middleware.js +5 -1
  6. package/dist/cjs/editing/index.js +3 -1
  7. package/dist/cjs/editing/vercel-editing-data-cache.js +48 -0
  8. package/dist/cjs/index.js +32 -2
  9. package/dist/cjs/middleware/index.js +3 -1
  10. package/dist/cjs/middleware/multisite-middleware.js +2 -1
  11. package/dist/cjs/middleware/personalize-middleware.js +6 -2
  12. package/dist/cjs/middleware/redirects-middleware.js +2 -1
  13. package/dist/cjs/services/base-graphql-sitemap-service.js +3 -3
  14. package/dist/cjs/services/component-props-service.js +2 -2
  15. package/dist/esm/ComponentBuilder.js +3 -1
  16. package/dist/esm/components/BYOCWrapper.js +42 -0
  17. package/dist/esm/components/FEaaSWrapper.js +44 -0
  18. package/dist/esm/editing/editing-render-middleware.js +5 -1
  19. package/dist/esm/editing/index.js +1 -0
  20. package/dist/esm/editing/vercel-editing-data-cache.js +44 -0
  21. package/dist/esm/index.js +6 -2
  22. package/dist/esm/middleware/index.js +1 -0
  23. package/dist/esm/middleware/multisite-middleware.js +2 -1
  24. package/dist/esm/middleware/personalize-middleware.js +6 -2
  25. package/dist/esm/middleware/redirects-middleware.js +2 -1
  26. package/dist/esm/services/base-graphql-sitemap-service.js +3 -3
  27. package/dist/esm/services/component-props-service.js +2 -2
  28. package/package.json +9 -8
  29. package/types/ComponentBuilder.d.ts +1 -1
  30. package/types/components/BYOCWrapper.d.ts +19 -0
  31. package/types/components/FEaaSWrapper.d.ts +21 -0
  32. package/types/components/Link.d.ts +1 -1
  33. package/types/components/Placeholder.d.ts +2 -1
  34. package/types/editing/index.d.ts +1 -0
  35. package/types/editing/vercel-editing-data-cache.d.ts +19 -0
  36. package/types/index.d.ts +7 -3
  37. package/types/middleware/index.d.ts +1 -0
  38. package/types/services/base-graphql-sitemap-service.d.ts +1 -1
  39. package/types/sharedTypes/component-props.d.ts +5 -1
package/README.md CHANGED
@@ -6,4 +6,4 @@ This module is provided as a part of Sitecore JavaScript Rendering SDK. It conta
6
6
 
7
7
  [Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
8
8
 
9
- [API reference documentation](/ref-docs/sitecore-jss-nextjs/)
9
+ [API reference documentation](/ref-docs/sitecore-jss-nextjs/)
package/dist/cjs/ComponentBuilder.js CHANGED
@@ -54,7 +54,9 @@ class ComponentBuilder {
54
54
  if (exportName && exportName !== this.DEFAULT_EXPORT_NAME) {
55
55
  return component[exportName];
56
56
  }
57
- return component.Default || component.default || null;
57
+ return (component.Default ||
58
+ component.default ||
59
+ component);
58
60
  };
59
61
  }
60
62
  }
package/dist/cjs/components/BYOCWrapper.js ADDED
@@ -0,0 +1,47 @@
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 BYOCWrapper 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
+ * @returns {GetStaticPropsContext} context
23
+ */
24
+ const getStaticProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
25
+ if (process.env.JSS_MODE === sitecore_jss_1.constants.JSS_MODE.DISCONNECTED) {
26
+ return null;
27
+ }
28
+ const params = rendering.params || {};
29
+ const result = yield (0, sitecore_jss_react_1.fetchBYOCComponentServerProps)(params);
30
+ return result;
31
+ });
32
+ exports.getStaticProps = getStaticProps;
33
+ /**
34
+ * Will be called during SSR
35
+ * @param {ComponentRendering} rendering
36
+ * @returns {GetStaticPropsContext} context
37
+ */
38
+ const getServerSideProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
39
+ if (process.env.JSS_MODE === sitecore_jss_1.constants.JSS_MODE.DISCONNECTED) {
40
+ return null;
41
+ }
42
+ const params = rendering.params || {};
43
+ const result = yield (0, sitecore_jss_react_1.fetchBYOCComponentServerProps)(params);
44
+ return result;
45
+ });
46
+ exports.getServerSideProps = getServerSideProps;
47
+ exports.default = sitecore_jss_react_1.BYOCWrapper;
package/dist/cjs/components/FEaaSWrapper.js ADDED
@@ -0,0 +1,49 @@
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;
package/dist/cjs/editing/editing-render-middleware.js CHANGED
@@ -29,6 +29,7 @@ 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();
32
33
  sitecore_jss_1.debug.editing('editing render middleware start: %o', {
33
34
  method,
34
35
  query,
@@ -104,7 +105,10 @@ class EditingRenderMiddleware {
104
105
  }
105
106
  const body = { html };
106
107
  // Return expected JSON result
107
- sitecore_jss_1.debug.editing('editing render middleware end: %o', { status: 200, body });
108
+ sitecore_jss_1.debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
109
+ status: 200,
110
+ body,
111
+ });
108
112
  res.status(200).json(body);
109
113
  }
110
114
  catch (err) {
package/dist/cjs/editing/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = void 0;
3
+ exports.VercelEditingDataCache = 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,3 +11,5 @@ 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/editing/vercel-editing-data-cache.js ADDED
@@ -0,0 +1,48 @@
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;
package/dist/cjs/index.js CHANGED
@@ -1,12 +1,36 @@
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
+ };
2
25
  Object.defineProperty(exports, "__esModule", { value: true });
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;
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.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = void 0;
5
28
  var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
6
29
  Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
7
30
  Object.defineProperty(exports, "AxiosDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.AxiosDataFetcher; } });
8
31
  Object.defineProperty(exports, "NativeDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.NativeDataFetcher; } });
9
32
  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; } });
10
34
  // we will remove the root exports for these later
11
35
  // we cannot mark exports as deprected directly, so we're using this hack instead
12
36
  const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
@@ -82,6 +106,10 @@ var EditingComponentPlaceholder_1 = require("./components/EditingComponentPlaceh
82
106
  Object.defineProperty(exports, "EditingComponentPlaceholder", { enumerable: true, get: function () { return EditingComponentPlaceholder_1.EditingComponentPlaceholder; } });
83
107
  var NextImage_1 = require("./components/NextImage");
84
108
  Object.defineProperty(exports, "NextImage", { enumerable: true, get: function () { return NextImage_1.NextImage; } });
109
+ const FEaaSWrapper = __importStar(require("./components/FEaaSWrapper"));
110
+ exports.FEaaSWrapper = FEaaSWrapper;
111
+ const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
112
+ exports.BYOCWrapper = BYOCWrapper;
85
113
  var ComponentBuilder_1 = require("./ComponentBuilder");
86
114
  Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
87
115
  var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
@@ -91,6 +119,8 @@ Object.defineProperty(exports, "DateField", { enumerable: true, get: function ()
91
119
  Object.defineProperty(exports, "EditFrame", { enumerable: true, get: function () { return sitecore_jss_react_1.EditFrame; } });
92
120
  Object.defineProperty(exports, "FEaaSComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.FEaaSComponent; } });
93
121
  Object.defineProperty(exports, "fetchFEaaSComponentServerProps", { enumerable: true, get: function () { return sitecore_jss_react_1.fetchFEaaSComponentServerProps; } });
122
+ Object.defineProperty(exports, "BYOCComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCComponent; } });
123
+ Object.defineProperty(exports, "getFEAASLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getFEAASLibraryStylesheetLinks; } });
94
124
  Object.defineProperty(exports, "File", { enumerable: true, get: function () { return sitecore_jss_react_1.File; } });
95
125
  Object.defineProperty(exports, "VisitorIdentification", { enumerable: true, get: function () { return sitecore_jss_react_1.VisitorIdentification; } });
96
126
  Object.defineProperty(exports, "SitecoreContext", { enumerable: true, get: function () { return sitecore_jss_react_1.SitecoreContext; } });
package/dist/cjs/middleware/index.js CHANGED
@@ -1,6 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MultisiteMiddleware = exports.PersonalizeMiddleware = exports.RedirectsMiddleware = void 0;
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; } });
4
6
  var redirects_middleware_1 = require("./redirects-middleware");
5
7
  Object.defineProperty(exports, "RedirectsMiddleware", { enumerable: true, get: function () { return redirects_middleware_1.RedirectsMiddleware; } });
6
8
  var personalize_middleware_1 = require("./personalize-middleware");
package/dist/cjs/middleware/multisite-middleware.js CHANGED
@@ -29,6 +29,7 @@ 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();
32
33
  sitecore_jss_1.debug.multisite('multisite middleware start: %o', {
33
34
  pathname,
34
35
  language,
@@ -58,7 +59,7 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
58
59
  response.cookies.set(this.SITE_SYMBOL, siteName);
59
60
  // Share rewrite path with following executed middlewares
60
61
  response.headers.set('x-sc-rewrite', rewritePath);
61
- sitecore_jss_1.debug.multisite('multisite middleware end: %o', {
62
+ sitecore_jss_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
62
63
  rewritePath,
63
64
  siteName,
64
65
  headers: this.extractDebugHeaders(response.headers),
package/dist/cjs/middleware/personalize-middleware.js CHANGED
@@ -28,6 +28,7 @@ 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();
31
32
  let browserId = this.getBrowserId(req);
32
33
  sitecore_jss_1.debug.personalize('personalize middleware start: %o', {
33
34
  pathname,
@@ -98,7 +99,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
98
99
  this.setBrowserId(response, browserId);
99
100
  // Share site name with the following executed middlewares
100
101
  response.cookies.set(this.SITE_SYMBOL, site.name);
101
- sitecore_jss_1.debug.personalize('personalize middleware end: %o', {
102
+ sitecore_jss_1.debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
102
103
  rewritePath,
103
104
  browserId,
104
105
  headers: this.extractDebugHeaders(response.headers),
@@ -149,7 +150,10 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
149
150
  }
150
151
  getExperienceParams(req) {
151
152
  return {
152
- referrer: req.referrer,
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,
153
157
  utm: {
154
158
  campaign: req.nextUrl.searchParams.get('utm_campaign'),
155
159
  content: req.nextUrl.searchParams.get('utm_content'),
package/dist/cjs/middleware/redirects-middleware.js CHANGED
@@ -35,6 +35,7 @@ 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();
38
39
  sitecore_jss_1.debug.redirects('redirects middleware start: %o', {
39
40
  pathname,
40
41
  language,
@@ -94,7 +95,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
94
95
  // Share site name with the following executed middlewares
95
96
  // Don't need to set when middleware is disabled
96
97
  site && response.cookies.set(this.SITE_SYMBOL, site.name);
97
- sitecore_jss_1.debug.redirects('redirects middleware end: %o', {
98
+ sitecore_jss_1.debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
98
99
  redirected: response.redirected,
99
100
  status: response.status,
100
101
  url: response.url,
package/dist/cjs/services/base-graphql-sitemap-service.js CHANGED
@@ -36,7 +36,7 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
36
36
  $language: String!
37
37
  $includedPaths: [String]
38
38
  $excludedPaths: [String]
39
- $pageSize: Int = 10
39
+ $pageSize: Int = 100
40
40
  $after: String
41
41
  ) {
42
42
  site {
@@ -132,7 +132,7 @@ class BaseGraphQLSitemapService {
132
132
  getTranformedPaths(siteName, languages, formatStaticPath) {
133
133
  return __awaiter(this, void 0, void 0, function* () {
134
134
  const paths = new Array();
135
- yield Promise.all(languages.map((language) => __awaiter(this, void 0, void 0, function* () {
135
+ for (const language of languages) {
136
136
  if (language === '') {
137
137
  throw new RangeError(languageEmptyError);
138
138
  }
@@ -140,7 +140,7 @@ class BaseGraphQLSitemapService {
140
140
  const results = yield this.fetchLanguageSitePaths(language, siteName);
141
141
  const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language);
142
142
  paths.push(...transformedPaths);
143
- })));
143
+ }
144
144
  return paths;
145
145
  });
146
146
  }
package/dist/cjs/services/component-props-service.js CHANGED
@@ -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 ${uid}: ${error.message ||
132
- error}`;
131
+ const errLog = `Error during preload data for component ${req.rendering.componentName} (${uid}): ${error.message || error}`;
133
132
  console.error(chalk_1.default.red(errLog));
134
133
  componentProps[uid] = {
135
134
  error: error.message || errLog,
135
+ componentName: req.rendering.componentName,
136
136
  };
137
137
  });
138
138
  });
package/dist/esm/ComponentBuilder.js CHANGED
@@ -51,7 +51,9 @@ export class ComponentBuilder {
51
51
  if (exportName && exportName !== this.DEFAULT_EXPORT_NAME) {
52
52
  return component[exportName];
53
53
  }
54
- return component.Default || component.default || null;
54
+ return (component.Default ||
55
+ component.default ||
56
+ component);
55
57
  };
56
58
  }
57
59
  }
package/dist/esm/components/BYOCWrapper.js ADDED
@@ -0,0 +1,42 @@
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 { BYOCWrapper, fetchBYOCComponentServerProps, } from '@sitecore-jss/sitecore-jss-react';
11
+ import { constants } from '@sitecore-jss/sitecore-jss';
12
+ /**
13
+ * This is a repackaged version of the React BYOCWrapper 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
+ * @returns {GetStaticPropsContext} context
20
+ */
21
+ export const getStaticProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
22
+ if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
23
+ return null;
24
+ }
25
+ const params = rendering.params || {};
26
+ const result = yield fetchBYOCComponentServerProps(params);
27
+ return result;
28
+ });
29
+ /**
30
+ * Will be called during SSR
31
+ * @param {ComponentRendering} rendering
32
+ * @returns {GetStaticPropsContext} context
33
+ */
34
+ export const getServerSideProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
35
+ if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
36
+ return null;
37
+ }
38
+ const params = rendering.params || {};
39
+ const result = yield fetchBYOCComponentServerProps(params);
40
+ return result;
41
+ });
42
+ export default BYOCWrapper;
package/dist/esm/components/FEaaSWrapper.js ADDED
@@ -0,0 +1,44 @@
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;
package/dist/esm/editing/editing-render-middleware.js CHANGED
@@ -26,6 +26,7 @@ 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();
29
30
  debug.editing('editing render middleware start: %o', {
30
31
  method,
31
32
  query,
@@ -101,7 +102,10 @@ export class EditingRenderMiddleware {
101
102
  }
102
103
  const body = { html };
103
104
  // Return expected JSON result
104
- debug.editing('editing render middleware end: %o', { status: 200, body });
105
+ debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
106
+ status: 200,
107
+ body,
108
+ });
105
109
  res.status(200).json(body);
106
110
  }
107
111
  catch (err) {
package/dist/esm/editing/index.js CHANGED
@@ -2,3 +2,4 @@ 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/editing/vercel-editing-data-cache.js ADDED
@@ -0,0 +1,44 @@
1
+ import { createClient } from '@vercel/kv';
2
+ import { debug } from '@sitecore-jss/sitecore-jss';
3
+ /**
4
+ * Implementation of editing cache for Vercel deployments
5
+ * Uses Vercel KV database and client to store data
6
+ * Set TTL for cache data in constructor (default: 60 seconds)
7
+ */
8
+ export class VercelEditingDataCache {
9
+ /**
10
+ * @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
11
+ * @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
12
+ */
13
+ constructor(redisUrl, redisToken) {
14
+ this.defaultTtl = 120;
15
+ if (!redisUrl || !redisToken) {
16
+ throw Error('API URL or token are missing, ensure you have set the KV or Upstash storage correctly.');
17
+ }
18
+ this.redisCache = createClient({
19
+ url: redisUrl,
20
+ token: redisToken,
21
+ });
22
+ }
23
+ set(key, editingData) {
24
+ debug.editing(`Putting editing data for ${key} into redis storage...`);
25
+ return new Promise((resolve, reject) => {
26
+ this.redisCache
27
+ .set(key, JSON.stringify(editingData), { ex: this.defaultTtl })
28
+ .then(() => resolve())
29
+ .catch((err) => reject(err));
30
+ });
31
+ }
32
+ get(key) {
33
+ debug.editing(`Getting editing data for ${key} from redis storage...`);
34
+ return new Promise((resolve, reject) => {
35
+ this.redisCache
36
+ .get(key)
37
+ .then((entry) => {
38
+ const result = (entry || undefined);
39
+ this.redisCache.expire(key, 0).then(() => resolve(result));
40
+ })
41
+ .catch((err) => reject(err));
42
+ });
43
+ }
44
+ }
package/dist/esm/index.js CHANGED
@@ -1,4 +1,4 @@
1
- export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, } from '@sitecore-jss/sitecore-jss';
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
4
  import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
@@ -31,5 +31,9 @@ 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
+ import * as BYOCWrapper from './components/BYOCWrapper';
36
+ export { FEaaSWrapper };
37
+ export { BYOCWrapper };
34
38
  export { ComponentBuilder } from './ComponentBuilder';
35
- export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
39
+ export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
package/dist/esm/middleware/index.js CHANGED
@@ -1,3 +1,4 @@
1
+ export { debug } from '@sitecore-jss/sitecore-jss';
1
2
  export { RedirectsMiddleware } from './redirects-middleware';
2
3
  export { PersonalizeMiddleware } from './personalize-middleware';
3
4
  export { MultisiteMiddleware } from './multisite-middleware';
package/dist/esm/middleware/multisite-middleware.js CHANGED
@@ -26,6 +26,7 @@ export class MultisiteMiddleware extends MiddlewareBase {
26
26
  const pathname = req.nextUrl.pathname;
27
27
  const language = this.getLanguage(req);
28
28
  const hostname = this.getHostHeader(req) || this.defaultHostname;
29
+ const startTimestamp = Date.now();
29
30
  debug.multisite('multisite middleware start: %o', {
30
31
  pathname,
31
32
  language,
@@ -55,7 +56,7 @@ export class MultisiteMiddleware extends MiddlewareBase {
55
56
  response.cookies.set(this.SITE_SYMBOL, siteName);
56
57
  // Share rewrite path with following executed middlewares
57
58
  response.headers.set('x-sc-rewrite', rewritePath);
58
- debug.multisite('multisite middleware end: %o', {
59
+ debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
59
60
  rewritePath,
60
61
  siteName,
61
62
  headers: this.extractDebugHeaders(response.headers),
package/dist/esm/middleware/personalize-middleware.js CHANGED
@@ -25,6 +25,7 @@ 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();
28
29
  let browserId = this.getBrowserId(req);
29
30
  debug.personalize('personalize middleware start: %o', {
30
31
  pathname,
@@ -95,7 +96,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
95
96
  this.setBrowserId(response, browserId);
96
97
  // Share site name with the following executed middlewares
97
98
  response.cookies.set(this.SITE_SYMBOL, site.name);
98
- debug.personalize('personalize middleware end: %o', {
99
+ debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
99
100
  rewritePath,
100
101
  browserId,
101
102
  headers: this.extractDebugHeaders(response.headers),
@@ -146,7 +147,10 @@ export class PersonalizeMiddleware extends MiddlewareBase {
146
147
  }
147
148
  getExperienceParams(req) {
148
149
  return {
149
- referrer: req.referrer,
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,
150
154
  utm: {
151
155
  campaign: req.nextUrl.searchParams.get('utm_campaign'),
152
156
  content: req.nextUrl.searchParams.get('utm_content'),
package/dist/esm/middleware/redirects-middleware.js CHANGED
@@ -29,6 +29,7 @@ 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();
32
33
  debug.redirects('redirects middleware start: %o', {
33
34
  pathname,
34
35
  language,
@@ -88,7 +89,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
88
89
  // Share site name with the following executed middlewares
89
90
  // Don't need to set when middleware is disabled
90
91
  site && response.cookies.set(this.SITE_SYMBOL, site.name);
91
- debug.redirects('redirects middleware end: %o', {
92
+ debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
92
93
  redirected: response.redirected,
93
94
  status: response.status,
94
95
  url: response.url,
package/dist/esm/services/base-graphql-sitemap-service.js CHANGED
@@ -32,7 +32,7 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
32
32
  $language: String!
33
33
  $includedPaths: [String]
34
34
  $excludedPaths: [String]
35
- $pageSize: Int = 10
35
+ $pageSize: Int = 100
36
36
  $after: String
37
37
  ) {
38
38
  site {
@@ -128,7 +128,7 @@ export class BaseGraphQLSitemapService {
128
128
  getTranformedPaths(siteName, languages, formatStaticPath) {
129
129
  return __awaiter(this, void 0, void 0, function* () {
130
130
  const paths = new Array();
131
- yield Promise.all(languages.map((language) => __awaiter(this, void 0, void 0, function* () {
131
+ for (const language of languages) {
132
132
  if (language === '') {
133
133
  throw new RangeError(languageEmptyError);
134
134
  }
@@ -136,7 +136,7 @@ export class BaseGraphQLSitemapService {
136
136
  const results = yield this.fetchLanguageSitePaths(language, siteName);
137
137
  const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language);
138
138
  paths.push(...transformedPaths);
139
- })));
139
+ }
140
140
  return paths;
141
141
  });
142
142
  }
package/dist/esm/services/component-props-service.js CHANGED
@@ -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 ${uid}: ${error.message ||
126
- error}`;
125
+ const errLog = `Error during preload data for component ${req.rendering.componentName} (${uid}): ${error.message || error}`;
127
126
  console.error(chalk.red(errLog));
128
127
  componentProps[uid] = {
129
128
  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.10",
3
+ "version": "21.4.0-canary.11",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "sideEffects": false,
@@ -37,7 +37,7 @@
37
37
  "@types/mocha": "^10.0.1",
38
38
  "@types/node": "~18.11.18",
39
39
  "@types/prop-types": "^15.7.5",
40
- "@types/react": "^18.0.27",
40
+ "@types/react": "^18.2.22",
41
41
  "@types/react-dom": "^18.0.10",
42
42
  "@types/sinon": "^10.0.13",
43
43
  "@types/sinon-chai": "^3.2.9",
@@ -54,7 +54,7 @@
54
54
  "eslint-plugin-react": "^7.32.1",
55
55
  "jsdom": "^21.1.0",
56
56
  "mocha": "^10.2.0",
57
- "next": "^13.1.6",
57
+ "next": "^13.4.16",
58
58
  "nock": "^13.3.0",
59
59
  "nyc": "^15.1.0",
60
60
  "react": "^18.2.0",
@@ -65,14 +65,15 @@
65
65
  "typescript": "~4.9.4"
66
66
  },
67
67
  "peerDependencies": {
68
- "next": "^13.1.6",
68
+ "next": "^13.4.16",
69
69
  "react": "^18.2.0",
70
70
  "react-dom": "^18.2.0"
71
71
  },
72
72
  "dependencies": {
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",
73
+ "@sitecore-jss/sitecore-jss": "^21.4.0-canary.11",
74
+ "@sitecore-jss/sitecore-jss-dev-tools": "^21.4.0-canary.11",
75
+ "@sitecore-jss/sitecore-jss-react": "^21.4.0-canary.11",
76
+ "@vercel/kv": "^0.2.1",
76
77
  "node-html-parser": "^6.1.4",
77
78
  "prop-types": "^15.8.1",
78
79
  "regex-parser": "^2.2.11",
@@ -80,7 +81,7 @@
80
81
  },
81
82
  "description": "",
82
83
  "types": "types/index.d.ts",
83
- "gitHead": "f0d7b8f28bd068b3342afa61f5226386fa7dff7c",
84
+ "gitHead": "1b0eeeb98dbe3e9dbb139cf28719572987bd83c8",
84
85
  "files": [
85
86
  "dist",
86
87
  "types",
package/types/ComponentBuilder.d.ts CHANGED
@@ -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;
14
+ type Component = Module | LazyModule | ComponentType;
15
15
  /**
16
16
  * Configuration for ComponentBuilder
17
17
  */
package/types/components/BYOCWrapper.d.ts ADDED
@@ -0,0 +1,19 @@
1
+ import { BYOCWrapper } from '@sitecore-jss/sitecore-jss-react';
2
+ import { GetStaticComponentProps, GetServerSideComponentProps } from '../sharedTypes/component-props';
3
+ /**
4
+ * This is a repackaged version of the React BYOCWrapper 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
+ * @returns {GetStaticPropsContext} context
11
+ */
12
+ export declare const getStaticProps: GetStaticComponentProps;
13
+ /**
14
+ * Will be called during SSR
15
+ * @param {ComponentRendering} rendering
16
+ * @returns {GetStaticPropsContext} context
17
+ */
18
+ export declare const getServerSideProps: GetServerSideComponentProps;
19
+ export default BYOCWrapper;
package/types/components/FEaaSWrapper.d.ts ADDED
@@ -0,0 +1,21 @@
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;
package/types/components/Link.d.ts CHANGED
@@ -7,4 +7,4 @@ export type LinkProps = ReactLinkProps & {
7
7
  */
8
8
  internalLinkMatcher?: RegExp;
9
9
  };
10
- export declare const Link: React.ForwardRefExoticComponent<Pick<LinkProps, "key" | keyof React.AnchorHTMLAttributes<HTMLAnchorElement> | "field" | "editable" | "showLinkTextWithChildrenPresent" | "internalLinkMatcher"> & React.RefAttributes<HTMLAnchorElement>>;
10
+ export declare const Link: React.ForwardRefExoticComponent<Omit<LinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
package/types/components/Placeholder.d.ts CHANGED
@@ -1,2 +1,3 @@
1
+ import React from 'react';
1
2
  import { PlaceholderComponentProps } from '@sitecore-jss/sitecore-jss-react';
2
- export declare const Placeholder: (props: PlaceholderComponentProps) => JSX.Element;
3
+ export declare const Placeholder: (props: PlaceholderComponentProps) => React.JSX.Element;
package/types/editing/index.d.ts CHANGED
@@ -3,3 +3,4 @@ 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/editing/vercel-editing-data-cache.d.ts ADDED
@@ -0,0 +1,19 @@
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
+ }
package/types/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, } from '@sitecore-jss/sitecore-jss';
1
+ export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } 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, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
13
+ export { ComponentPropsCollection, ComponentPropsError, 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,5 +24,9 @@ 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
+ import * as BYOCWrapper from './components/BYOCWrapper';
29
+ export { FEaaSWrapper };
30
+ export { BYOCWrapper };
27
31
  export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
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';
32
+ export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getFEAASLibraryStylesheetLinks, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';
package/types/middleware/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ export { debug } from '@sitecore-jss/sitecore-jss';
1
2
  export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
2
3
  export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
3
4
  export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';
package/types/services/base-graphql-sitemap-service.d.ts CHANGED
@@ -30,7 +30,7 @@ interface SiteRouteQueryVariables {
30
30
  /** common variable for all GraphQL queries
31
31
  * it will be used for every type of query to regulate result batch size
32
32
  * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
33
- * @default 10
33
+ * @default 100
34
34
  */
35
35
  pageSize?: number;
36
36
  }
package/types/sharedTypes/component-props.d.ts CHANGED
@@ -1,10 +1,14 @@
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
+ };
3
7
  /**
4
8
  * Shape of component props storage
5
9
  */
6
10
  export type ComponentPropsCollection = {
7
- [componentUid: string]: unknown;
11
+ [componentUid: string]: unknown | ComponentPropsError;
8
12
  };
9
13
  /**
10
14
  * Type of side effect function which could be invoked on component level (getStaticProps/getServerSideProps)