@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.9 → 22.1.0-canary.1

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 (103) 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/Link.js +4 -0
  8. package/dist/cjs/components/NextImage.js +2 -10
  9. package/dist/cjs/components/RichText.js +10 -10
  10. package/dist/cjs/context/context.js +83 -0
  11. package/dist/cjs/context/index.js +5 -0
  12. package/dist/cjs/editing/constants.js +6 -0
  13. package/dist/cjs/editing/editing-config-middleware.js +49 -0
  14. package/dist/cjs/editing/editing-data-middleware.js +3 -3
  15. package/dist/cjs/editing/editing-data-service.js +16 -8
  16. package/dist/cjs/editing/editing-render-middleware.js +25 -11
  17. package/dist/cjs/editing/feaas-render-middleware.js +87 -0
  18. package/dist/cjs/editing/index.js +7 -1
  19. package/dist/cjs/editing/render-middleware.js +27 -0
  20. package/dist/cjs/editing/vercel-editing-data-cache.js +48 -0
  21. package/dist/cjs/graphql/index.js +7 -0
  22. package/dist/cjs/index.js +38 -14
  23. package/dist/cjs/middleware/index.js +3 -5
  24. package/dist/cjs/middleware/middleware.js +18 -2
  25. package/dist/cjs/middleware/multisite-middleware.js +14 -8
  26. package/dist/cjs/middleware/personalize-middleware.js +62 -56
  27. package/dist/cjs/middleware/redirects-middleware.js +64 -21
  28. package/dist/cjs/services/base-graphql-sitemap-service.js +7 -6
  29. package/dist/cjs/services/component-props-service.js +6 -6
  30. package/dist/cjs/site/index.js +5 -0
  31. package/dist/cjs/utils/index.js +11 -0
  32. package/dist/cjs/{utils.js → utils/utils.js} +7 -16
  33. package/dist/esm/ComponentBuilder.js +59 -0
  34. package/dist/esm/components/BYOCWrapper.js +42 -0
  35. package/dist/esm/components/FEaaSWrapper.js +44 -0
  36. package/dist/esm/components/Link.js +4 -0
  37. package/dist/esm/components/NextImage.js +1 -8
  38. package/dist/esm/components/RichText.js +10 -10
  39. package/dist/esm/context/context.js +79 -0
  40. package/dist/esm/context/index.js +1 -0
  41. package/dist/esm/editing/constants.js +3 -0
  42. package/dist/esm/editing/editing-config-middleware.js +45 -0
  43. package/dist/esm/editing/editing-data-middleware.js +2 -2
  44. package/dist/esm/editing/editing-data-service.js +14 -6
  45. package/dist/esm/editing/editing-render-middleware.js +25 -11
  46. package/dist/esm/editing/feaas-render-middleware.js +83 -0
  47. package/dist/esm/editing/index.js +3 -0
  48. package/dist/esm/editing/render-middleware.js +23 -0
  49. package/dist/esm/editing/vercel-editing-data-cache.js +44 -0
  50. package/dist/esm/graphql/index.js +1 -0
  51. package/dist/esm/index.js +10 -7
  52. package/dist/esm/middleware/index.js +1 -2
  53. package/dist/esm/middleware/middleware.js +18 -2
  54. package/dist/esm/middleware/multisite-middleware.js +14 -8
  55. package/dist/esm/middleware/personalize-middleware.js +65 -59
  56. package/dist/esm/middleware/redirects-middleware.js +64 -21
  57. package/dist/esm/services/base-graphql-sitemap-service.js +7 -6
  58. package/dist/esm/services/component-props-service.js +6 -6
  59. package/dist/esm/site/index.js +1 -0
  60. package/dist/esm/utils/index.js +2 -0
  61. package/dist/esm/{utils.js → utils/utils.js} +7 -13
  62. package/graphql.d.ts +1 -0
  63. package/graphql.js +1 -0
  64. package/package.json +15 -12
  65. package/site.d.ts +1 -0
  66. package/site.js +1 -0
  67. package/types/ComponentBuilder.d.ts +61 -0
  68. package/types/components/BYOCWrapper.d.ts +19 -0
  69. package/types/components/ComponentPropsContext.d.ts +1 -0
  70. package/types/components/FEaaSWrapper.d.ts +21 -0
  71. package/types/components/Link.d.ts +2 -1
  72. package/types/components/NextImage.d.ts +3 -3
  73. package/types/components/Placeholder.d.ts +3 -1
  74. package/types/components/RichText.d.ts +6 -0
  75. package/types/context/context.d.ts +116 -0
  76. package/types/context/index.d.ts +1 -0
  77. package/types/editing/constants.d.ts +3 -0
  78. package/types/editing/editing-config-middleware.d.ts +29 -0
  79. package/types/editing/editing-data-service.d.ts +12 -4
  80. package/types/editing/editing-render-middleware.d.ts +2 -1
  81. package/types/editing/feaas-render-middleware.d.ts +32 -0
  82. package/types/editing/index.d.ts +3 -0
  83. package/types/editing/render-middleware.d.ts +15 -0
  84. package/types/editing/vercel-editing-data-cache.d.ts +19 -0
  85. package/types/graphql/index.d.ts +1 -0
  86. package/types/index.d.ts +12 -9
  87. package/types/middleware/index.d.ts +1 -2
  88. package/types/middleware/middleware.d.ts +8 -0
  89. package/types/middleware/multisite-middleware.d.ts +15 -0
  90. package/types/middleware/personalize-middleware.d.ts +53 -14
  91. package/types/middleware/redirects-middleware.d.ts +1 -1
  92. package/types/services/base-graphql-sitemap-service.d.ts +7 -10
  93. package/types/services/component-props-service.d.ts +2 -2
  94. package/types/sharedTypes/component-props.d.ts +5 -1
  95. package/types/sharedTypes/module-factory.d.ts +33 -0
  96. package/types/site/index.d.ts +1 -0
  97. package/types/utils/index.d.ts +2 -0
  98. package/types/{utils.d.ts → utils/utils.d.ts} +2 -0
  99. package/utils.d.ts +1 -0
  100. package/utils.js +1 -0
  101. package/types/sharedTypes/component-module.d.ts +0 -13
  102. /package/dist/cjs/sharedTypes/{component-module.js → module-factory.js} +0 -0
  103. /package/dist/esm/sharedTypes/{component-module.js → module-factory.js} +0 -0
@@ -7,10 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
7
7
  step((generator = generator.apply(thisArg, _arguments || [])).next());
8
8
  });
9
9
  };
10
- import { NextResponse, userAgent } from 'next/server';
11
- import { GraphQLPersonalizeService, CdpService, getPersonalizedRewrite, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
12
- import { debug, NativeDataFetcher } from '@sitecore-jss/sitecore-jss';
10
+ import { NextResponse } from 'next/server';
11
+ import { GraphQLPersonalizeService, getPersonalizedRewrite, } from '@sitecore-jss/sitecore-jss/personalize';
12
+ import { debug } from '@sitecore-jss/sitecore-jss';
13
13
  import { MiddlewareBase } from './middleware';
14
+ import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
14
15
  /**
15
16
  * Middleware / handler to support Sitecore Personalize
16
17
  */
@@ -25,15 +26,16 @@ export class PersonalizeMiddleware extends MiddlewareBase {
25
26
  const pathname = req.nextUrl.pathname;
26
27
  const language = this.getLanguage(req);
27
28
  const hostname = this.getHostHeader(req) || this.defaultHostname;
28
- let browserId = this.getBrowserId(req);
29
+ const startTimestamp = Date.now();
30
+ const timeout = this.config.cdpConfig.timeout;
31
+ // Response will be provided if other middleware is run before us (e.g. redirects)
32
+ let response = res || NextResponse.next();
29
33
  debug.personalize('personalize middleware start: %o', {
30
34
  pathname,
31
35
  language,
32
36
  hostname,
33
- browserId,
37
+ headers: this.extractDebugHeaders(req.headers),
34
38
  });
35
- // Response will be provided if other middleware is run before us (e.g. redirects)
36
- let response = res || NextResponse.next();
37
39
  if (this.config.disabled && this.config.disabled(req, response)) {
38
40
  debug.personalize('skipped (personalize middleware is disabled)');
39
41
  return response;
@@ -44,7 +46,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
44
46
  debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
45
47
  return response;
46
48
  }
47
- const site = this.getSite(req, res);
49
+ const site = this.getSite(req, response);
48
50
  // Get personalization info from Experience Edge
49
51
  const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
50
52
  if (!personalizeInfo) {
@@ -56,20 +58,24 @@ export class PersonalizeMiddleware extends MiddlewareBase {
56
58
  debug.personalize('skipped (no personalization configured)');
57
59
  return response;
58
60
  }
59
- if (!browserId) {
60
- browserId = yield this.cdpService.generateBrowserId();
61
- if (!browserId) {
62
- debug.personalize('skipped (browser id generation failed)');
63
- return response;
64
- }
65
- }
66
- // Execute targeted experience in CDP
67
- const { ua } = userAgent(req);
61
+ yield this.initPersonalizeServer({
62
+ hostname,
63
+ siteName: site.name,
64
+ request: req,
65
+ response,
66
+ });
68
67
  const params = this.getExperienceParams(req);
69
- const pointOfSale = this.config.getPointOfSale
70
- ? this.config.getPointOfSale(site, language)
71
- : PosResolver.resolve(site, language);
72
- const variantId = yield this.cdpService.executeExperience(personalizeInfo.contentId, browserId, ua, pointOfSale, params);
68
+ debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
69
+ let variantId;
70
+ // Execute targeted experience in Personalize SDK
71
+ // eslint-disable-next-line no-useless-catch
72
+ try {
73
+ const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
74
+ variantId = personalization.variantId;
75
+ }
76
+ catch (error) {
77
+ throw error;
78
+ }
73
79
  if (!variantId) {
74
80
  debug.personalize('skipped (no variant identified)');
75
81
  return response;
@@ -82,22 +88,12 @@ export class PersonalizeMiddleware extends MiddlewareBase {
82
88
  const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
83
89
  // Rewrite to persononalized path
84
90
  const rewritePath = getPersonalizedRewrite(basePath, { variantId });
85
- // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
86
- const rewriteUrl = req.nextUrl.clone();
87
- rewriteUrl.pathname = rewritePath;
88
- response = NextResponse.rewrite(rewriteUrl);
91
+ response = this.rewrite(rewritePath, req, response);
89
92
  // Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
90
93
  // See https://github.com/vercel/next.js/issues/32727
91
94
  response.headers.set('x-middleware-cache', 'no-cache');
92
- // Share rewrite path with following executed middlewares
93
- response.headers.set('x-sc-rewrite', rewritePath);
94
- // Set browserId cookie on the response
95
- this.setBrowserId(response, browserId);
96
- // Share site name with the following executed middlewares
97
- response.cookies.set(this.SITE_SYMBOL, site.name);
98
- debug.personalize('personalize middleware end: %o', {
95
+ debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
99
96
  rewritePath,
100
- browserId,
101
97
  headers: this.extractDebugHeaders(response.headers),
102
98
  });
103
99
  return response;
@@ -105,15 +101,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
105
101
  // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
106
102
  // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
107
103
  this.personalizeService = new GraphQLPersonalizeService(Object.assign(Object.assign({}, config.edgeConfig), { fetch: fetch }));
108
- // NOTE: same here, we provide NativeDataFetcher for compatibility on Next.js Edge Runtime
109
- this.cdpService = new CdpService(Object.assign(Object.assign({}, config.cdpConfig), { dataFetcherResolver: ({ timeout, headers, }) => {
110
- const fetcher = new NativeDataFetcher({
111
- debugger: debug.personalize,
112
- timeout,
113
- headers,
114
- });
115
- return (url, data) => fetcher.fetch(url, data);
116
- } }));
117
104
  }
118
105
  /**
119
106
  * Gets the Next.js middleware handler with error handling
@@ -131,28 +118,47 @@ export class PersonalizeMiddleware extends MiddlewareBase {
131
118
  }
132
119
  });
133
120
  }
134
- get browserIdCookieName() {
135
- // Each user should have saved identifier to connect between session, CDP uses bid cookies + local storage
136
- return `BID_${this.config.cdpConfig.clientKey}`;
121
+ initPersonalizeServer({ hostname, siteName, request, response, }) {
122
+ return __awaiter(this, void 0, void 0, function* () {
123
+ yield init(request, response, {
124
+ sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
125
+ sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
126
+ siteName,
127
+ cookieDomain: hostname,
128
+ enableServerCookie: true,
129
+ });
130
+ });
137
131
  }
138
- getBrowserId(req) {
132
+ personalize({ params, personalizeInfo, language, timeout, }, request) {
139
133
  var _a;
140
- return ((_a = req.cookies.get(this.browserIdCookieName)) === null || _a === void 0 ? void 0 : _a.value) || undefined;
141
- }
142
- setBrowserId(res, browserId) {
143
- const expiryDate = new Date(new Date().setFullYear(new Date().getFullYear() + 2));
144
- const options = { expires: expiryDate, secure: true };
145
- res.cookies.set(this.browserIdCookieName, browserId, options);
134
+ return __awaiter(this, void 0, void 0, function* () {
135
+ const personalizationData = {
136
+ channel: this.config.cdpConfig.channel || 'WEB',
137
+ currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
138
+ friendlyId: personalizeInfo.contentId,
139
+ params,
140
+ language,
141
+ };
142
+ return (yield personalize(request, personalizationData, { timeout }));
143
+ });
146
144
  }
147
145
  getExperienceParams(req) {
146
+ const utm = {
147
+ campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined,
148
+ content: req.nextUrl.searchParams.get('utm_content') || undefined,
149
+ medium: req.nextUrl.searchParams.get('utm_medium') || undefined,
150
+ source: req.nextUrl.searchParams.get('utm_source') || undefined,
151
+ };
148
152
  return {
149
- referrer: req.referrer,
150
- utm: {
151
- campaign: req.nextUrl.searchParams.get('utm_campaign'),
152
- content: req.nextUrl.searchParams.get('utm_content'),
153
- medium: req.nextUrl.searchParams.get('utm_medium'),
154
- source: req.nextUrl.searchParams.get('utm_source'),
155
- },
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,
157
+ utm: utm,
156
158
  };
157
159
  }
160
+ excludeRoute(pathname) {
161
+ // ignore files
162
+ return pathname.includes('.') || super.excludeRoute(pathname);
163
+ }
158
164
  }
@@ -12,6 +12,8 @@ import { NextResponse } from 'next/server';
12
12
  import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
13
13
  import { debug } from '@sitecore-jss/sitecore-jss';
14
14
  import { MiddlewareBase } from './middleware';
15
+ const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
16
+ const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
15
17
  /**
16
18
  * Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
17
19
  * compares with current url and redirects to target url
@@ -28,13 +30,14 @@ export class RedirectsMiddleware extends MiddlewareBase {
28
30
  const language = this.getLanguage(req);
29
31
  const hostname = this.getHostHeader(req) || this.defaultHostname;
30
32
  let site;
33
+ const startTimestamp = Date.now();
31
34
  debug.redirects('redirects middleware start: %o', {
32
35
  pathname,
33
36
  language,
34
37
  hostname,
35
38
  });
36
39
  const createResponse = () => __awaiter(this, void 0, void 0, function* () {
37
- if (this.config.disabled && this.config.disabled(req, NextResponse.next())) {
40
+ if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
38
41
  debug.redirects('skipped (redirects middleware is disabled)');
39
42
  return res || NextResponse.next();
40
43
  }
@@ -49,41 +52,59 @@ export class RedirectsMiddleware extends MiddlewareBase {
49
52
  debug.redirects('skipped (redirect does not exist)');
50
53
  return res || NextResponse.next();
51
54
  }
55
+ // Find context site language and replace token
56
+ if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
57
+ !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
58
+ existsRedirect.target.includes(hostname))) {
59
+ existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
60
+ }
52
61
  const url = req.nextUrl.clone();
53
- const absoluteUrlRegex = new RegExp('^(?:[a-z]+:)?//', 'i');
54
- if (absoluteUrlRegex.test(existsRedirect.target)) {
62
+ if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
55
63
  url.href = existsRedirect.target;
56
- url.locale = req.nextUrl.locale;
57
64
  }
58
65
  else {
66
+ const source = `${url.pathname}${url.search}`;
59
67
  url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
60
68
  const urlFirstPart = existsRedirect.target.split('/')[1];
61
69
  if (this.locales.includes(urlFirstPart)) {
62
70
  url.locale = urlFirstPart;
63
- url.pathname = existsRedirect.target.replace(`/${urlFirstPart}`, '');
71
+ existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
64
72
  }
65
- else {
66
- url.pathname = existsRedirect.target;
73
+ const target = source
74
+ .replace(regexParser(existsRedirect.pattern), existsRedirect.target)
75
+ .replace(/^\/\//, '/')
76
+ .split('?');
77
+ url.pathname = target[0];
78
+ if (target[1]) {
79
+ const newParams = new URLSearchParams(target[1]);
80
+ for (const [key, val] of newParams.entries()) {
81
+ url.searchParams.append(key, val);
82
+ }
67
83
  }
68
84
  }
69
85
  const redirectUrl = decodeURIComponent(url.href);
70
86
  /** return Response redirect with http code of redirect type **/
71
87
  switch (existsRedirect.redirectType) {
72
88
  case REDIRECT_TYPE_301:
73
- return NextResponse.redirect(redirectUrl, 301);
89
+ return NextResponse.redirect(redirectUrl, {
90
+ status: 301,
91
+ statusText: 'Moved Permanently',
92
+ headers: res === null || res === void 0 ? void 0 : res.headers,
93
+ });
74
94
  case REDIRECT_TYPE_302:
75
- return NextResponse.redirect(redirectUrl, 302);
95
+ return NextResponse.redirect(redirectUrl, {
96
+ status: 302,
97
+ statusText: 'Found',
98
+ headers: res === null || res === void 0 ? void 0 : res.headers,
99
+ });
76
100
  case REDIRECT_TYPE_SERVER_TRANSFER:
77
- return NextResponse.rewrite(redirectUrl);
101
+ return NextResponse.rewrite(redirectUrl, res);
78
102
  default:
79
- return NextResponse.next();
103
+ return res || NextResponse.next();
80
104
  }
81
105
  });
82
106
  const response = yield createResponse();
83
- // Share site name with the following executed middlewares
84
- // Don't need to set when middleware is disabled
85
- site && response.cookies.set(this.SITE_SYMBOL, site.name);
86
- debug.redirects('redirects middleware end: %o', {
107
+ debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
87
108
  redirected: response.redirected,
88
109
  status: response.status,
89
110
  url: response.url,
@@ -97,11 +118,20 @@ export class RedirectsMiddleware extends MiddlewareBase {
97
118
  this.locales = config.locales;
98
119
  }
99
120
  /**
100
- * Gets the Next.js API route handler
121
+ * Gets the Next.js middleware handler with error handling
101
122
  * @returns route handler
102
123
  */
103
124
  getHandler() {
104
- return this.handler;
125
+ return (req, res) => __awaiter(this, void 0, void 0, function* () {
126
+ try {
127
+ return yield this.handler(req, res);
128
+ }
129
+ catch (error) {
130
+ console.log('Redirect middleware failed:');
131
+ console.log(error);
132
+ return res || NextResponse.next();
133
+ }
134
+ });
105
135
  }
106
136
  /**
107
137
  * Method returns RedirectInfo when matches
@@ -113,10 +143,23 @@ export class RedirectsMiddleware extends MiddlewareBase {
113
143
  getExistsRedirect(req, siteName) {
114
144
  return __awaiter(this, void 0, void 0, function* () {
115
145
  const redirects = yield this.redirectsService.fetchRedirects(siteName);
116
- return redirects.length
117
- ? redirects.find((redirect) => {
118
- return ((regexParser(redirect.pattern.toLowerCase()).test(req.nextUrl.pathname.toLowerCase()) ||
119
- regexParser(redirect.pattern.toLowerCase()).test(`/${req.nextUrl.locale}${req.nextUrl.pathname}`.toLowerCase())) &&
146
+ const tragetURL = req.nextUrl.pathname;
147
+ const targetQS = req.nextUrl.search || '';
148
+ const language = this.getLanguage(req);
149
+ const modifyRedirects = structuredClone(redirects);
150
+ return modifyRedirects.length
151
+ ? modifyRedirects.find((redirect) => {
152
+ redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
153
+ redirect.pattern = `/^\/${redirect.pattern
154
+ .replace(/^\/|\/$/g, '')
155
+ .replace(/^\^\/|\/\$$/g, '')
156
+ .replace(/^\^|\$$/g, '')
157
+ .replace(/(?<!\\)\?/g, '\\?')
158
+ .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
159
+ return ((regexParser(redirect.pattern).test(tragetURL) ||
160
+ regexParser(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
161
+ regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
162
+ regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}${targetQS}`)) &&
120
163
  (redirect.locale
121
164
  ? redirect.locale.toLowerCase() === req.nextUrl.locale.toLowerCase()
122
165
  : true));
@@ -7,7 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
7
7
  step((generator = generator.apply(thisArg, _arguments || [])).next());
8
8
  });
9
9
  };
10
- import { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss/graphql';
11
10
  import { debug } from '@sitecore-jss/sitecore-jss';
12
11
  import { getPersonalizedRewrite } from '@sitecore-jss/sitecore-jss/personalize';
13
12
  /** @private */
@@ -32,7 +31,7 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
32
31
  $language: String!
33
32
  $includedPaths: [String]
34
33
  $excludedPaths: [String]
35
- $pageSize: Int = 10
34
+ $pageSize: Int = 100
36
35
  $after: String
37
36
  ) {
38
37
  site {
@@ -128,7 +127,7 @@ export class BaseGraphQLSitemapService {
128
127
  getTranformedPaths(siteName, languages, formatStaticPath) {
129
128
  return __awaiter(this, void 0, void 0, function* () {
130
129
  const paths = new Array();
131
- yield Promise.all(languages.map((language) => __awaiter(this, void 0, void 0, function* () {
130
+ for (const language of languages) {
132
131
  if (language === '') {
133
132
  throw new RangeError(languageEmptyError);
134
133
  }
@@ -136,7 +135,7 @@ export class BaseGraphQLSitemapService {
136
135
  const results = yield this.fetchLanguageSitePaths(language, siteName);
137
136
  const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language);
138
137
  paths.push(...transformedPaths);
139
- })));
138
+ }
140
139
  return paths;
141
140
  });
142
141
  }
@@ -191,8 +190,10 @@ export class BaseGraphQLSitemapService {
191
190
  * @returns {GraphQLClient} implementation
192
191
  */
193
192
  getGraphQLClient() {
194
- return new GraphQLRequestClient(this.options.endpoint, {
195
- apiKey: this.options.apiKey,
193
+ if (!this.options.clientFactory) {
194
+ throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
195
+ }
196
+ return this.options.clientFactory({
196
197
  debugger: debug.sitemap,
197
198
  });
198
199
  }
@@ -17,9 +17,9 @@ export class ComponentPropsService {
17
17
  */
18
18
  fetchServerSideComponentProps(params) {
19
19
  return __awaiter(this, void 0, void 0, function* () {
20
- const { componentModule, layoutData, context } = params;
20
+ const { moduleFactory, layoutData, context } = params;
21
21
  const fetchFunctionFactory = (componentName) => __awaiter(this, void 0, void 0, function* () {
22
- const module = yield componentModule(componentName);
22
+ const module = yield moduleFactory(componentName);
23
23
  return module === null || module === void 0 ? void 0 : module.getServerSideProps;
24
24
  });
25
25
  return this.fetchComponentProps(fetchFunctionFactory, layoutData, context);
@@ -33,9 +33,9 @@ export class ComponentPropsService {
33
33
  */
34
34
  fetchStaticComponentProps(params) {
35
35
  return __awaiter(this, void 0, void 0, function* () {
36
- const { componentModule, layoutData, context } = params;
36
+ const { moduleFactory, layoutData, context } = params;
37
37
  const fetchFunctionFactory = (componentName) => __awaiter(this, void 0, void 0, function* () {
38
- const module = yield componentModule(componentName);
38
+ const module = yield moduleFactory(componentName);
39
39
  return module === null || module === void 0 ? void 0 : module.getStaticProps;
40
40
  });
41
41
  return this.fetchComponentProps(fetchFunctionFactory, layoutData, context);
@@ -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
  });
@@ -0,0 +1 @@
1
+ export { SiteResolver } from '@sitecore-jss/sitecore-jss/site';
@@ -0,0 +1,2 @@
1
+ export { getPublicUrl, handleEditorFastRefresh } from './utils';
2
+ export { tryParseEnvValue, isEditorActive, resetEditorChromes, resolveUrl, } from '@sitecore-jss/sitecore-jss/utils';
@@ -1,4 +1,3 @@
1
- import chalk from 'chalk';
2
1
  import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/utils';
3
2
  /**
4
3
  * Get the publicUrl.
@@ -6,25 +5,20 @@ import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/u
6
5
  * This is set to http://localhost:3000 by default.
7
6
  * VERCEL_URL is provided by Vercel in case if we are in Preview deployment (deployment based on the custom branch),
8
7
  * preview deployment has unique url, we don't know exact url.
8
+ * Similarly, DEPLOY_URL is provided by Netlify and would give us the deploy URL
9
+ * In production non-editing environments it is desirable to use relative urls, so in that case set PUBLIC_URL = ''
9
10
  */
10
11
  export const getPublicUrl = () => {
11
- if (process.env.VERCEL_URL)
12
- return `https://${process.env.VERCEL_URL}`;
13
12
  let url = process.env.PUBLIC_URL;
14
13
  if (url === undefined) {
15
- console.warn(`${chalk.yellow.bold('Warning:')} An PUBLIC_URL environment variable is not defined. Falling back to http://localhost:3000.`);
14
+ if (process.env.NETLIFY && process.env.DEPLOY_URL)
15
+ return process.env.DEPLOY_URL;
16
+ if (process.env.VERCEL_URL)
17
+ return `https://${process.env.VERCEL_URL}`;
16
18
  url = 'http://localhost:3000';
17
19
  }
18
- else {
19
- try {
20
- new URL(url);
21
- }
22
- catch (error) {
23
- throw new Error(`The PUBLIC_URL environment variable '${url}' is not a valid URL.`);
24
- }
25
- }
26
20
  // Ensure no trailing slash
27
- return url.toString().replace(/\/$/, '');
21
+ return url.replace(/\/$/, '');
28
22
  };
29
23
  /**
30
24
  * Since Sitecore editors do not support Fast Refresh:
package/graphql.d.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './types/graphql/index';
package/graphql.js ADDED
@@ -0,0 +1 @@
1
+ module.exports = require('./dist/cjs/graphql/index');
package/package.json CHANGED
@@ -1,21 +1,20 @@
1
1
  {
2
2
  "name": "@sitecore-jss/sitecore-jss-nextjs",
3
- "version": "22.0.0-canary.9",
3
+ "version": "22.1.0-canary.1",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "sideEffects": false,
7
7
  "scripts": {
8
8
  "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
9
9
  "clean": "del-cli dist types",
10
- "lint": "eslint ./src/**/*.tsx ./src/**/*.ts",
10
+ "lint": "eslint \"./src/**/*.tsx\" \"./src/**/*.ts\"",
11
11
  "test": "mocha --require ./test/setup.js \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
12
12
  "prepublishOnly": "npm run build",
13
13
  "coverage": "nyc npm test",
14
- "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --githubPages false"
14
+ "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
15
15
  },
16
16
  "engines": {
17
- "node": ">=12",
18
- "npm": ">=6"
17
+ "node": ">=18"
19
18
  },
20
19
  "author": {
21
20
  "name": "Sitecore Corporation",
@@ -30,6 +29,7 @@
30
29
  "url": "https://github.com/sitecore/jss/issues"
31
30
  },
32
31
  "devDependencies": {
32
+ "@sitecore-cloudsdk/personalize": "^0.3.0",
33
33
  "@types/chai": "^4.3.4",
34
34
  "@types/chai-as-promised": "^7.1.5",
35
35
  "@types/chai-string": "^1.4.2",
@@ -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": "^14.1.0",
58
58
  "nock": "^13.3.0",
59
59
  "nyc": "^15.1.0",
60
60
  "react": "^18.2.0",
@@ -65,14 +65,17 @@
65
65
  "typescript": "~4.9.4"
66
66
  },
67
67
  "peerDependencies": {
68
- "next": "^13.1.6",
68
+ "@sitecore-cloudsdk/events": "^0.3.0",
69
+ "@sitecore-cloudsdk/personalize": "^0.3.0",
70
+ "next": "^14.1.0",
69
71
  "react": "^18.2.0",
70
72
  "react-dom": "^18.2.0"
71
73
  },
72
74
  "dependencies": {
73
- "@sitecore-jss/sitecore-jss": "^22.0.0-canary.9",
74
- "@sitecore-jss/sitecore-jss-dev-tools": "^22.0.0-canary.9",
75
- "@sitecore-jss/sitecore-jss-react": "^22.0.0-canary.9",
75
+ "@sitecore-jss/sitecore-jss": "^22.1.0-canary.1",
76
+ "@sitecore-jss/sitecore-jss-dev-tools": "^22.1.0-canary.1",
77
+ "@sitecore-jss/sitecore-jss-react": "^22.1.0-canary.1",
78
+ "@vercel/kv": "^0.2.1",
76
79
  "node-html-parser": "^6.1.4",
77
80
  "prop-types": "^15.8.1",
78
81
  "regex-parser": "^2.2.11",
@@ -80,7 +83,7 @@
80
83
  },
81
84
  "description": "",
82
85
  "types": "types/index.d.ts",
83
- "gitHead": "f28c2255e8bc93787848a7778b6a32355590e7b4",
86
+ "gitHead": "30a3425acc99805adeb0d95ce469db9325c0f83d",
84
87
  "files": [
85
88
  "dist",
86
89
  "types",
package/site.d.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './types/site/index';
package/site.js ADDED
@@ -0,0 +1 @@
1
+ module.exports = require('./dist/cjs/site/index');
@@ -0,0 +1,61 @@
1
+ /// <reference types="@types/react" />
2
+ import { ComponentFactory } from '@sitecore-jss/sitecore-jss-react';
3
+ import { Module, ModuleFactory } from './sharedTypes/module-factory';
4
+ import { ComponentType } from 'react';
5
+ /**
6
+ * Represents a component that can be imported dynamically
7
+ */
8
+ export type LazyModule = {
9
+ module: () => Promise<Module>;
10
+ element: (isEditing?: boolean) => ComponentType;
11
+ };
12
+ /**
13
+ * Component is a module or a lazy module
14
+ */
15
+ type Component = Module | LazyModule | ComponentType;
16
+ /**
17
+ * Configuration for ComponentBuilder
18
+ */
19
+ export type ComponentBuilderConfig<Component> = {
20
+ /**
21
+ * List of components to be stored
22
+ */
23
+ components: Map<string, Component>;
24
+ };
25
+ /**
26
+ * Configuration for ComponentFactory
27
+ */
28
+ type ComponentFactoryConfig = {
29
+ isEditing?: boolean;
30
+ };
31
+ /**
32
+ * Nextjs implementation of component builder class for building components based on the configuration.
33
+ */
34
+ export declare class ComponentBuilder {
35
+ protected config: ComponentBuilderConfig<Component>;
36
+ /**
37
+ * List of components to be stored
38
+ */
39
+ protected components: Map<string, Component>;
40
+ /**
41
+ * SXA uses custom default export name
42
+ */
43
+ protected DEFAULT_EXPORT_NAME: string;
44
+ constructor(config: ComponentBuilderConfig<Component>);
45
+ /**
46
+ * Creates a new instance of module factory
47
+ * Module factory provides a module (file) including all exports.
48
+ * Module can be imported dynamically or statically.
49
+ * @returns {ModuleFactory} Module factory implementation
50
+ */
51
+ getModuleFactory(): ModuleFactory;
52
+ /**
53
+ * Creates a new instance of component factory
54
+ * Component can be imported dynamically or statically.
55
+ * @param {Object} [config] Component factory configuration
56
+ * @param {boolean} [config.isEditing] Indicates if component factory is used in editing mode
57
+ * @returns {ComponentFactory} Component factory implementation
58
+ */
59
+ getComponentFactory({ isEditing }?: ComponentFactoryConfig): ComponentFactory;
60
+ }
61
+ export {};
@@ -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;