@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.38 → 22.0.0-canary.42

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 (90) hide show
  1. package/README.md +5 -3
  2. package/context.d.ts +1 -0
  3. package/context.js +1 -0
  4. package/dist/cjs/ComponentBuilder.js +63 -0
  5. package/dist/cjs/components/BYOCWrapper.js +47 -0
  6. package/dist/cjs/components/FEaaSWrapper.js +49 -0
  7. package/dist/cjs/components/NextImage.js +2 -10
  8. package/dist/cjs/components/RichText.js +10 -10
  9. package/dist/cjs/context/context.js +83 -0
  10. package/dist/cjs/context/index.js +5 -0
  11. package/dist/cjs/editing/constants.js +6 -0
  12. package/dist/cjs/editing/editing-config-middleware.js +49 -0
  13. package/dist/cjs/editing/editing-data-middleware.js +2 -2
  14. package/dist/cjs/editing/editing-data-service.js +15 -7
  15. package/dist/cjs/editing/editing-render-middleware.js +24 -10
  16. package/dist/cjs/editing/feaas-render-middleware.js +87 -0
  17. package/dist/cjs/editing/index.js +7 -1
  18. package/dist/cjs/editing/render-middleware.js +27 -0
  19. package/dist/cjs/editing/vercel-editing-data-cache.js +48 -0
  20. package/dist/cjs/graphql/index.js +7 -0
  21. package/dist/cjs/index.js +37 -25
  22. package/dist/cjs/middleware/index.js +3 -1
  23. package/dist/cjs/middleware/middleware.js +18 -2
  24. package/dist/cjs/middleware/multisite-middleware.js +14 -8
  25. package/dist/cjs/middleware/personalize-middleware.js +62 -56
  26. package/dist/cjs/middleware/redirects-middleware.js +48 -25
  27. package/dist/cjs/services/base-graphql-sitemap-service.js +7 -6
  28. package/dist/cjs/services/component-props-service.js +6 -6
  29. package/dist/cjs/utils/utils.js +7 -16
  30. package/dist/esm/ComponentBuilder.js +59 -0
  31. package/dist/esm/components/BYOCWrapper.js +42 -0
  32. package/dist/esm/components/FEaaSWrapper.js +44 -0
  33. package/dist/esm/components/NextImage.js +1 -8
  34. package/dist/esm/components/RichText.js +10 -10
  35. package/dist/esm/context/context.js +79 -0
  36. package/dist/esm/context/index.js +1 -0
  37. package/dist/esm/editing/constants.js +3 -0
  38. package/dist/esm/editing/editing-config-middleware.js +45 -0
  39. package/dist/esm/editing/editing-data-middleware.js +1 -1
  40. package/dist/esm/editing/editing-data-service.js +13 -5
  41. package/dist/esm/editing/editing-render-middleware.js +24 -10
  42. package/dist/esm/editing/feaas-render-middleware.js +83 -0
  43. package/dist/esm/editing/index.js +3 -0
  44. package/dist/esm/editing/render-middleware.js +23 -0
  45. package/dist/esm/editing/vercel-editing-data-cache.js +44 -0
  46. package/dist/esm/graphql/index.js +1 -0
  47. package/dist/esm/index.js +10 -20
  48. package/dist/esm/middleware/index.js +1 -0
  49. package/dist/esm/middleware/middleware.js +18 -2
  50. package/dist/esm/middleware/multisite-middleware.js +14 -8
  51. package/dist/esm/middleware/personalize-middleware.js +65 -59
  52. package/dist/esm/middleware/redirects-middleware.js +48 -25
  53. package/dist/esm/services/base-graphql-sitemap-service.js +7 -6
  54. package/dist/esm/services/component-props-service.js +6 -6
  55. package/dist/esm/utils/utils.js +7 -13
  56. package/graphql.d.ts +1 -0
  57. package/graphql.js +1 -0
  58. package/package.json +15 -12
  59. package/types/ComponentBuilder.d.ts +61 -0
  60. package/types/components/BYOCWrapper.d.ts +19 -0
  61. package/types/components/ComponentPropsContext.d.ts +1 -0
  62. package/types/components/FEaaSWrapper.d.ts +21 -0
  63. package/types/components/Link.d.ts +2 -1
  64. package/types/components/NextImage.d.ts +3 -3
  65. package/types/components/Placeholder.d.ts +3 -1
  66. package/types/components/RichText.d.ts +6 -0
  67. package/types/context/context.d.ts +116 -0
  68. package/types/context/index.d.ts +1 -0
  69. package/types/editing/constants.d.ts +3 -0
  70. package/types/editing/editing-config-middleware.d.ts +29 -0
  71. package/types/editing/editing-data-service.d.ts +12 -4
  72. package/types/editing/editing-render-middleware.d.ts +2 -1
  73. package/types/editing/feaas-render-middleware.d.ts +32 -0
  74. package/types/editing/index.d.ts +3 -0
  75. package/types/editing/render-middleware.d.ts +15 -0
  76. package/types/editing/vercel-editing-data-cache.d.ts +19 -0
  77. package/types/graphql/index.d.ts +1 -0
  78. package/types/index.d.ts +12 -12
  79. package/types/middleware/index.d.ts +1 -0
  80. package/types/middleware/middleware.d.ts +8 -0
  81. package/types/middleware/multisite-middleware.d.ts +15 -0
  82. package/types/middleware/personalize-middleware.d.ts +53 -14
  83. package/types/services/base-graphql-sitemap-service.d.ts +7 -10
  84. package/types/services/component-props-service.d.ts +2 -2
  85. package/types/sharedTypes/component-props.d.ts +5 -1
  86. package/types/sharedTypes/module-factory.d.ts +33 -0
  87. package/types/utils/utils.d.ts +2 -0
  88. package/types/sharedTypes/component-module.d.ts +0 -13
  89. /package/dist/cjs/sharedTypes/{component-module.js → module-factory.js} +0 -0
  90. /package/dist/esm/sharedTypes/{component-module.js → module-factory.js} +0 -0
package/dist/cjs/editing/feaas-render-middleware.js ADDED
@@ -0,0 +1,87 @@
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.FEAASRenderMiddleware = void 0;
13
+ const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
14
+ const constants_1 = require("./constants");
15
+ const utils_1 = require("../utils/utils");
16
+ const render_middleware_1 = require("./render-middleware");
17
+ /**
18
+ * Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
19
+ * which is required for Sitecore editing support.
20
+ */
21
+ class FEAASRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
22
+ /**
23
+ * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
24
+ */
25
+ constructor(config) {
26
+ var _a;
27
+ super();
28
+ this.config = config;
29
+ this.defaultPageUrl = '/feaas/render';
30
+ this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
31
+ const { method, query, headers } = req;
32
+ const startTimestamp = Date.now();
33
+ sitecore_jss_1.debug.editing('feaas render middleware start: %o', {
34
+ method,
35
+ query,
36
+ headers,
37
+ });
38
+ if (method !== 'GET') {
39
+ sitecore_jss_1.debug.editing('invalid method - sent %s expected GET', method);
40
+ res.setHeader('Allow', 'GET');
41
+ return res.status(405).send(`<html><body>Invalid request method '${method}'</body></html>`);
42
+ }
43
+ // Validate secret
44
+ const secret = query[constants_1.QUERY_PARAM_EDITING_SECRET];
45
+ if (secret !== (0, utils_1.getJssEditingSecret)()) {
46
+ sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
47
+ return res.status(401).send('<html><body>Missing or invalid secret</body></html>');
48
+ }
49
+ try {
50
+ // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
51
+ const params = this.getQueryParamsForPropagation(query);
52
+ // Enable Next.js Preview Mode
53
+ res.setPreviewData({});
54
+ const queryParams = new URLSearchParams();
55
+ for (const key in params) {
56
+ if ({}.hasOwnProperty.call(params, key)) {
57
+ queryParams.append(key, params[key]);
58
+ }
59
+ }
60
+ // Pass "feaasSrc" in case a FEAASComponent is being requested
61
+ if (query.feaasSrc) {
62
+ queryParams.append('feaasSrc', query.feaasSrc);
63
+ }
64
+ const redirectUrl = this.pageUrl + (queryParams.toString() ? `?${queryParams.toString()}` : '');
65
+ sitecore_jss_1.debug.editing('redirecting to page route %s', redirectUrl);
66
+ sitecore_jss_1.debug.editing('feaas render middleware end in %dms', Date.now() - startTimestamp);
67
+ res.redirect(redirectUrl);
68
+ }
69
+ catch (err) {
70
+ const error = err;
71
+ console.info(
72
+ // eslint-disable-next-line quotes
73
+ "Hint: for non-standard server or Next.js route configurations, you may need to override the 'pageUrl' available on the 'FEAASRenderMiddleware' config.");
74
+ res.status(500).send(`<html><body>${error}</body></html>`);
75
+ }
76
+ });
77
+ this.pageUrl = (_a = config === null || config === void 0 ? void 0 : config.pageUrl) !== null && _a !== void 0 ? _a : this.defaultPageUrl;
78
+ }
79
+ /**
80
+ * Gets the Next.js API route handler
81
+ * @returns route handler
82
+ */
83
+ getHandler() {
84
+ return this.handler;
85
+ }
86
+ }
87
+ exports.FEAASRenderMiddleware = FEAASRenderMiddleware;
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.EditingConfigMiddleware = exports.FEAASRenderMiddleware = 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,9 @@ 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; } });
16
+ var feaas_render_middleware_1 = require("./feaas-render-middleware");
17
+ Object.defineProperty(exports, "FEAASRenderMiddleware", { enumerable: true, get: function () { return feaas_render_middleware_1.FEAASRenderMiddleware; } });
18
+ var editing_config_middleware_1 = require("./editing-config-middleware");
19
+ Object.defineProperty(exports, "EditingConfigMiddleware", { enumerable: true, get: function () { return editing_config_middleware_1.EditingConfigMiddleware; } });
package/dist/cjs/editing/render-middleware.js ADDED
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RenderMiddlewareBase = void 0;
4
+ const constants_1 = require("./constants");
5
+ /**
6
+ * Base class for middleware that handles pages and components rendering in Sitecore Editors.
7
+ */
8
+ class RenderMiddlewareBase {
9
+ constructor() {
10
+ /**
11
+ * Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
12
+ * @param {Object} query Object of query parameters from incoming URL
13
+ * @returns Object of approved query parameters
14
+ */
15
+ this.getQueryParamsForPropagation = (query) => {
16
+ const params = {};
17
+ if (query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
18
+ params[constants_1.QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
19
+ }
20
+ if (query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
21
+ params[constants_1.QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[constants_1.QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
22
+ }
23
+ return params;
24
+ };
25
+ }
26
+ }
27
+ exports.RenderMiddlewareBase = RenderMiddlewareBase;
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/graphql/index.js ADDED
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getEdgeProxyContentUrl = exports.GraphQLRequestClient = exports.DefaultRetryStrategy = void 0;
4
+ var graphql_1 = require("@sitecore-jss/sitecore-jss/graphql");
5
+ Object.defineProperty(exports, "DefaultRetryStrategy", { enumerable: true, get: function () { return graphql_1.DefaultRetryStrategy; } });
6
+ Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_1.GraphQLRequestClient; } });
7
+ Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return graphql_1.getEdgeProxyContentUrl; } });
package/dist/cjs/index.js CHANGED
@@ -1,31 +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.Image = 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.getFEAASLibraryStylesheetLinks = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = void 0;
26
+ exports.DateField = exports.Text = exports.Image = exports.Context = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = exports.NextImage = exports.EditingComponentPlaceholder = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.getContentStylesheetLink = exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = 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.getComponentLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = 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; } });
10
- // we will remove the root exports for these later
11
- // we cannot mark exports as deprected directly, so we're using this hack instead
12
- const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
13
- const utils_2 = require("./utils");
14
- /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
15
- const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChromes, resolveUrlDep: resolveUrl, tryParseEnvValueDep: tryParseEnvValue, handleEditorFastRefreshDep: handleEditorFastRefresh, getPublicUrlDep: getPublicUrl, } = {
16
- isEditorActiveDep: utils_1.isEditorActive,
17
- resetEditorChromesDep: utils_1.resetEditorChromes,
18
- resolveUrlDep: utils_1.resolveUrl,
19
- tryParseEnvValueDep: utils_1.tryParseEnvValue,
20
- handleEditorFastRefreshDep: utils_2.handleEditorFastRefresh,
21
- getPublicUrlDep: utils_2.getPublicUrl,
22
- };
23
- exports.isEditorActive = isEditorActive;
24
- exports.resetEditorChromes = resetEditorChromes;
25
- exports.resolveUrl = resolveUrl;
26
- exports.tryParseEnvValue = tryParseEnvValue;
27
- exports.handleEditorFastRefresh = handleEditorFastRefresh;
28
- exports.getPublicUrl = getPublicUrl;
33
+ Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
29
34
  var layout_1 = require("@sitecore-jss/sitecore-jss/layout");
30
35
  Object.defineProperty(exports, "LayoutServicePageState", { enumerable: true, get: function () { return layout_1.LayoutServicePageState; } });
31
36
  Object.defineProperty(exports, "GraphQLLayoutService", { enumerable: true, get: function () { return layout_1.GraphQLLayoutService; } });
@@ -35,6 +40,7 @@ Object.defineProperty(exports, "getFieldValue", { enumerable: true, get: functio
35
40
  Object.defineProperty(exports, "RenderingType", { enumerable: true, get: function () { return layout_1.RenderingType; } });
36
41
  Object.defineProperty(exports, "EDITING_COMPONENT_PLACEHOLDER", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_PLACEHOLDER; } });
37
42
  Object.defineProperty(exports, "EDITING_COMPONENT_ID", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_ID; } });
43
+ Object.defineProperty(exports, "getContentStylesheetLink", { enumerable: true, get: function () { return layout_1.getContentStylesheetLink; } });
38
44
  var media_1 = require("@sitecore-jss/sitecore-jss/media");
39
45
  Object.defineProperty(exports, "mediaApi", { enumerable: true, get: function () { return media_1.mediaApi; } });
40
46
  var tracking_1 = require("@sitecore-jss/sitecore-jss/tracking");
@@ -48,9 +54,6 @@ Object.defineProperty(exports, "getPersonalizedRewrite", { enumerable: true, get
48
54
  Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true, get: function () { return personalize_1.getPersonalizedRewriteData; } });
49
55
  Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return personalize_1.normalizePersonalizedRewrite; } });
50
56
  Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return personalize_1.CdpHelper; } });
51
- Object.defineProperty(exports, "PosResolver", { enumerable: true, get: function () { return personalize_1.PosResolver; } });
52
- var sitecore_jss_2 = require("@sitecore-jss/sitecore-jss");
53
- Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return sitecore_jss_2.GraphQLRequestClient; } });
54
57
  var component_props_service_1 = require("./services/component-props-service");
55
58
  Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
56
59
  var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
@@ -82,6 +85,14 @@ var EditingComponentPlaceholder_1 = require("./components/EditingComponentPlaceh
82
85
  Object.defineProperty(exports, "EditingComponentPlaceholder", { enumerable: true, get: function () { return EditingComponentPlaceholder_1.EditingComponentPlaceholder; } });
83
86
  var NextImage_1 = require("./components/NextImage");
84
87
  Object.defineProperty(exports, "NextImage", { enumerable: true, get: function () { return NextImage_1.NextImage; } });
88
+ const FEaaSWrapper = __importStar(require("./components/FEaaSWrapper"));
89
+ exports.FEaaSWrapper = FEaaSWrapper;
90
+ const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
91
+ exports.BYOCWrapper = BYOCWrapper;
92
+ var ComponentBuilder_1 = require("./ComponentBuilder");
93
+ Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
94
+ var context_1 = require("./context");
95
+ Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
85
96
  var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
86
97
  Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return sitecore_jss_react_1.Image; } });
87
98
  Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return sitecore_jss_react_1.Text; } });
@@ -89,7 +100,8 @@ Object.defineProperty(exports, "DateField", { enumerable: true, get: function ()
89
100
  Object.defineProperty(exports, "EditFrame", { enumerable: true, get: function () { return sitecore_jss_react_1.EditFrame; } });
90
101
  Object.defineProperty(exports, "FEaaSComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.FEaaSComponent; } });
91
102
  Object.defineProperty(exports, "fetchFEaaSComponentServerProps", { enumerable: true, get: function () { return sitecore_jss_react_1.fetchFEaaSComponentServerProps; } });
92
- Object.defineProperty(exports, "getFEAASLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getFEAASLibraryStylesheetLinks; } });
103
+ Object.defineProperty(exports, "BYOCComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCComponent; } });
104
+ Object.defineProperty(exports, "getComponentLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getComponentLibraryStylesheetLinks; } });
93
105
  Object.defineProperty(exports, "File", { enumerable: true, get: function () { return sitecore_jss_react_1.File; } });
94
106
  Object.defineProperty(exports, "VisitorIdentification", { enumerable: true, get: function () { return sitecore_jss_react_1.VisitorIdentification; } });
95
107
  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/middleware.js CHANGED
@@ -1,10 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.MiddlewareBase = void 0;
4
+ const server_1 = require("next/server");
4
5
  class MiddlewareBase {
5
6
  constructor(config) {
6
7
  this.config = config;
7
8
  this.SITE_SYMBOL = 'sc_site';
9
+ this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
8
10
  this.defaultHostname = config.defaultHostname || 'localhost';
9
11
  }
10
12
  /**
@@ -18,8 +20,7 @@ class MiddlewareBase {
18
20
  }
19
21
  excludeRoute(pathname) {
20
22
  var _a, _b;
21
- return (pathname.includes('.') || // Ignore files
22
- pathname.startsWith('/api/') || // Ignore Next.js API calls
23
+ return (pathname.startsWith('/api/') || // Ignore Next.js API calls
23
24
  pathname.startsWith('/sitecore/') || // Ignore Sitecore API calls
24
25
  pathname.startsWith('/_next') || // Ignore next service calls
25
26
  (((_a = this.config) === null || _a === void 0 ? void 0 : _a.excludeRoute) && ((_b = this.config) === null || _b === void 0 ? void 0 : _b.excludeRoute(pathname))));
@@ -66,5 +67,20 @@ class MiddlewareBase {
66
67
  const hostname = this.getHostHeader(req) || this.defaultHostname;
67
68
  return this.config.siteResolver.getByHost(hostname);
68
69
  }
70
+ /**
71
+ * Create a rewrite response
72
+ * @param {string} rewritePath the destionation path
73
+ * @param {NextRequest} req the current request
74
+ * @param {NextResponse} res the current response
75
+ */
76
+ rewrite(rewritePath, req, res) {
77
+ // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
78
+ const rewriteUrl = req.nextUrl.clone();
79
+ rewriteUrl.pathname = rewritePath;
80
+ const response = server_1.NextResponse.rewrite(rewriteUrl, res);
81
+ // Share rewrite path with following executed middlewares
82
+ response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
83
+ return response;
84
+ }
69
85
  }
70
86
  exports.MiddlewareBase = MiddlewareBase;
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,
@@ -50,15 +51,16 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
50
51
  const rewritePath = (0, site_1.getSiteRewrite)(pathname, {
51
52
  siteName,
52
53
  });
53
- // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
54
- const rewriteUrl = req.nextUrl.clone();
55
- rewriteUrl.pathname = rewritePath;
56
- response = server_1.NextResponse.rewrite(rewriteUrl);
54
+ response = this.rewrite(rewritePath, req, response);
55
+ // default site cookie attributes
56
+ const defaultCookieAttributes = {
57
+ secure: true,
58
+ httpOnly: true,
59
+ sameSite: 'none',
60
+ };
57
61
  // Share site name with the following executed middlewares
58
- response.cookies.set(this.SITE_SYMBOL, siteName);
59
- // Share rewrite path with following executed middlewares
60
- response.headers.set('x-sc-rewrite', rewritePath);
61
- sitecore_jss_1.debug.multisite('multisite middleware end: %o', {
62
+ response.cookies.set(this.SITE_SYMBOL, siteName, defaultCookieAttributes);
63
+ sitecore_jss_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
62
64
  rewritePath,
63
65
  siteName,
64
66
  headers: this.extractDebugHeaders(response.headers),
@@ -83,5 +85,9 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
83
85
  }
84
86
  });
85
87
  }
88
+ excludeRoute(pathname) {
89
+ // ignore files
90
+ return pathname.includes('.') || super.excludeRoute(pathname);
91
+ }
86
92
  }
87
93
  exports.MultisiteMiddleware = MultisiteMiddleware;
package/dist/cjs/middleware/personalize-middleware.js CHANGED
@@ -14,6 +14,7 @@ const server_1 = require("next/server");
14
14
  const personalize_1 = require("@sitecore-jss/sitecore-jss/personalize");
15
15
  const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
16
16
  const middleware_1 = require("./middleware");
17
+ const server_2 = require("@sitecore-cloudsdk/personalize/server");
17
18
  /**
18
19
  * Middleware / handler to support Sitecore Personalize
19
20
  */
@@ -28,15 +29,16 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
28
29
  const pathname = req.nextUrl.pathname;
29
30
  const language = this.getLanguage(req);
30
31
  const hostname = this.getHostHeader(req) || this.defaultHostname;
31
- let browserId = this.getBrowserId(req);
32
+ const startTimestamp = Date.now();
33
+ const timeout = this.config.cdpConfig.timeout;
34
+ // Response will be provided if other middleware is run before us (e.g. redirects)
35
+ let response = res || server_1.NextResponse.next();
32
36
  sitecore_jss_1.debug.personalize('personalize middleware start: %o', {
33
37
  pathname,
34
38
  language,
35
39
  hostname,
36
- browserId,
40
+ headers: this.extractDebugHeaders(req.headers),
37
41
  });
38
- // Response will be provided if other middleware is run before us (e.g. redirects)
39
- let response = res || server_1.NextResponse.next();
40
42
  if (this.config.disabled && this.config.disabled(req, response)) {
41
43
  sitecore_jss_1.debug.personalize('skipped (personalize middleware is disabled)');
42
44
  return response;
@@ -47,7 +49,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
47
49
  sitecore_jss_1.debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
48
50
  return response;
49
51
  }
50
- const site = this.getSite(req, res);
52
+ const site = this.getSite(req, response);
51
53
  // Get personalization info from Experience Edge
52
54
  const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
53
55
  if (!personalizeInfo) {
@@ -59,20 +61,24 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
59
61
  sitecore_jss_1.debug.personalize('skipped (no personalization configured)');
60
62
  return response;
61
63
  }
62
- if (!browserId) {
63
- browserId = yield this.cdpService.generateBrowserId();
64
- if (!browserId) {
65
- sitecore_jss_1.debug.personalize('skipped (browser id generation failed)');
66
- return response;
67
- }
68
- }
69
- // Execute targeted experience in CDP
70
- const { ua } = (0, server_1.userAgent)(req);
64
+ yield this.initPersonalizeServer({
65
+ hostname,
66
+ siteName: site.name,
67
+ request: req,
68
+ response,
69
+ });
71
70
  const params = this.getExperienceParams(req);
72
- const pointOfSale = this.config.getPointOfSale
73
- ? this.config.getPointOfSale(site, language)
74
- : personalize_1.PosResolver.resolve(site, language);
75
- const variantId = yield this.cdpService.executeExperience(personalizeInfo.contentId, browserId, ua, pointOfSale, params);
71
+ sitecore_jss_1.debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
72
+ let variantId;
73
+ // Execute targeted experience in Personalize SDK
74
+ // eslint-disable-next-line no-useless-catch
75
+ try {
76
+ const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
77
+ variantId = personalization.variantId;
78
+ }
79
+ catch (error) {
80
+ throw error;
81
+ }
76
82
  if (!variantId) {
77
83
  sitecore_jss_1.debug.personalize('skipped (no variant identified)');
78
84
  return response;
@@ -85,22 +91,12 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
85
91
  const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
86
92
  // Rewrite to persononalized path
87
93
  const rewritePath = (0, personalize_1.getPersonalizedRewrite)(basePath, { variantId });
88
- // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
89
- const rewriteUrl = req.nextUrl.clone();
90
- rewriteUrl.pathname = rewritePath;
91
- response = server_1.NextResponse.rewrite(rewriteUrl);
94
+ response = this.rewrite(rewritePath, req, response);
92
95
  // Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
93
96
  // See https://github.com/vercel/next.js/issues/32727
94
97
  response.headers.set('x-middleware-cache', 'no-cache');
95
- // Share rewrite path with following executed middlewares
96
- response.headers.set('x-sc-rewrite', rewritePath);
97
- // Set browserId cookie on the response
98
- this.setBrowserId(response, browserId);
99
- // Share site name with the following executed middlewares
100
- response.cookies.set(this.SITE_SYMBOL, site.name);
101
- sitecore_jss_1.debug.personalize('personalize middleware end: %o', {
98
+ sitecore_jss_1.debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
102
99
  rewritePath,
103
- browserId,
104
100
  headers: this.extractDebugHeaders(response.headers),
105
101
  });
106
102
  return response;
@@ -108,15 +104,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
108
104
  // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
109
105
  // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
110
106
  this.personalizeService = new personalize_1.GraphQLPersonalizeService(Object.assign(Object.assign({}, config.edgeConfig), { fetch: fetch }));
111
- // NOTE: same here, we provide NativeDataFetcher for compatibility on Next.js Edge Runtime
112
- this.cdpService = new personalize_1.CdpService(Object.assign(Object.assign({}, config.cdpConfig), { dataFetcherResolver: ({ timeout, headers, }) => {
113
- const fetcher = new sitecore_jss_1.NativeDataFetcher({
114
- debugger: sitecore_jss_1.debug.personalize,
115
- timeout,
116
- headers,
117
- });
118
- return (url, data) => fetcher.fetch(url, data);
119
- } }));
120
107
  }
121
108
  /**
122
109
  * Gets the Next.js middleware handler with error handling
@@ -134,29 +121,48 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
134
121
  }
135
122
  });
136
123
  }
137
- get browserIdCookieName() {
138
- // Each user should have saved identifier to connect between session, CDP uses bid cookies + local storage
139
- return `BID_${this.config.cdpConfig.clientKey}`;
124
+ initPersonalizeServer({ hostname, siteName, request, response, }) {
125
+ return __awaiter(this, void 0, void 0, function* () {
126
+ yield (0, server_2.init)(request, response, {
127
+ sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
128
+ sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
129
+ siteName,
130
+ cookieDomain: hostname,
131
+ enableServerCookie: true,
132
+ });
133
+ });
140
134
  }
141
- getBrowserId(req) {
135
+ personalize({ params, personalizeInfo, language, timeout, }, request) {
142
136
  var _a;
143
- return ((_a = req.cookies.get(this.browserIdCookieName)) === null || _a === void 0 ? void 0 : _a.value) || undefined;
144
- }
145
- setBrowserId(res, browserId) {
146
- const expiryDate = new Date(new Date().setFullYear(new Date().getFullYear() + 2));
147
- const options = { expires: expiryDate, secure: true };
148
- res.cookies.set(this.browserIdCookieName, browserId, options);
137
+ return __awaiter(this, void 0, void 0, function* () {
138
+ const personalizationData = {
139
+ channel: this.config.cdpConfig.channel || 'WEB',
140
+ currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
141
+ friendlyId: personalizeInfo.contentId,
142
+ params,
143
+ language,
144
+ };
145
+ return (yield (0, server_2.personalize)(request, personalizationData, { timeout }));
146
+ });
149
147
  }
150
148
  getExperienceParams(req) {
149
+ const utm = {
150
+ campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined,
151
+ content: req.nextUrl.searchParams.get('utm_content') || undefined,
152
+ medium: req.nextUrl.searchParams.get('utm_medium') || undefined,
153
+ source: req.nextUrl.searchParams.get('utm_source') || undefined,
154
+ };
151
155
  return {
152
- referrer: req.referrer,
153
- utm: {
154
- campaign: req.nextUrl.searchParams.get('utm_campaign'),
155
- content: req.nextUrl.searchParams.get('utm_content'),
156
- medium: req.nextUrl.searchParams.get('utm_medium'),
157
- source: req.nextUrl.searchParams.get('utm_source'),
158
- },
156
+ // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
157
+ // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
158
+ // used as a fallback
159
+ referrer: req.headers.get('referer') || req.referrer,
160
+ utm: utm,
159
161
  };
160
162
  }
163
+ excludeRoute(pathname) {
164
+ // ignore files
165
+ return pathname.includes('.') || super.excludeRoute(pathname);
166
+ }
161
167
  }
162
168
  exports.PersonalizeMiddleware = PersonalizeMiddleware;