@sitecore-jss/sitecore-jss-nextjs 22.2.0-canary.9 → 22.2.0
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.
- package/LICENSE.txt +202 -202
- package/README.md +11 -11
- package/dist/cjs/components/NextImage.js +6 -1
- package/dist/cjs/editing/constants.js +1 -1
- package/dist/cjs/editing/editing-render-middleware.js +1 -1
- package/dist/cjs/index.js +2 -3
- package/dist/cjs/middleware/index.js +3 -1
- package/dist/cjs/middleware/personalize-middleware.js +7 -4
- package/dist/cjs/middleware/redirects-middleware.js +157 -42
- package/dist/esm/components/NextImage.js +8 -3
- package/dist/esm/editing/constants.js +1 -1
- package/dist/esm/editing/editing-render-middleware.js +1 -1
- package/dist/esm/index.js +1 -2
- package/dist/esm/middleware/index.js +1 -0
- package/dist/esm/middleware/personalize-middleware.js +6 -3
- package/dist/esm/middleware/redirects-middleware.js +157 -42
- package/package.json +11 -10
- package/types/editing/editing-render-middleware.d.ts +3 -0
- package/types/index.d.ts +1 -2
- package/types/middleware/index.d.ts +1 -0
- package/types/middleware/redirects-middleware.d.ts +29 -1
- package/context.d.ts +0 -1
- package/context.js +0 -1
- package/dist/cjs/context/context.js +0 -83
- package/dist/cjs/context/index.js +0 -5
- package/dist/esm/context/context.js +0 -79
- package/dist/esm/context/index.js +0 -1
- package/types/context/context.d.ts +0 -116
- package/types/context/index.d.ts +0 -1
|
@@ -13,10 +13,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
13
13
|
};
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
15
|
exports.RedirectsMiddleware = void 0;
|
|
16
|
-
const regex_parser_1 = __importDefault(require("regex-parser"));
|
|
17
|
-
const server_1 = require("next/server");
|
|
18
|
-
const site_1 = require("@sitecore-jss/sitecore-jss/site");
|
|
19
16
|
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
17
|
+
const site_1 = require("@sitecore-jss/sitecore-jss/site");
|
|
18
|
+
const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
|
|
19
|
+
const server_1 = require("next/server");
|
|
20
|
+
const regex_parser_1 = __importDefault(require("regex-parser"));
|
|
20
21
|
const middleware_1 = require("./middleware");
|
|
21
22
|
const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
|
|
22
23
|
const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
|
|
@@ -43,6 +44,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
|
|
|
43
44
|
hostname,
|
|
44
45
|
});
|
|
45
46
|
const createResponse = () => __awaiter(this, void 0, void 0, function* () {
|
|
47
|
+
var _a;
|
|
46
48
|
if (this.config.disabled && this.config.disabled(req, res || server_1.NextResponse.next())) {
|
|
47
49
|
sitecore_jss_1.debug.redirects('skipped (redirects middleware is disabled)');
|
|
48
50
|
return res || server_1.NextResponse.next();
|
|
@@ -63,48 +65,50 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
|
|
|
63
65
|
!(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
|
|
64
66
|
existsRedirect.target.includes(hostname))) {
|
|
65
67
|
existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
|
|
68
|
+
req.nextUrl.locale = site.language;
|
|
66
69
|
}
|
|
67
|
-
const url = req.nextUrl.clone();
|
|
70
|
+
const url = this.normalizeUrl(req.nextUrl.clone());
|
|
68
71
|
if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
|
|
69
72
|
url.href = existsRedirect.target;
|
|
70
73
|
}
|
|
71
74
|
else {
|
|
72
|
-
const source = `${url.pathname}${
|
|
73
|
-
url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
|
|
75
|
+
const source = `${url.pathname.replace(/\/*$/gi, '')}${existsRedirect.matchedQueryString}`;
|
|
74
76
|
const urlFirstPart = existsRedirect.target.split('/')[1];
|
|
75
77
|
if (this.locales.includes(urlFirstPart)) {
|
|
76
|
-
|
|
78
|
+
req.nextUrl.locale = urlFirstPart;
|
|
77
79
|
existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
|
|
78
80
|
}
|
|
79
81
|
const target = source
|
|
80
82
|
.replace((0, regex_parser_1.default)(existsRedirect.pattern), existsRedirect.target)
|
|
81
83
|
.replace(/^\/\//, '/')
|
|
82
84
|
.split('?');
|
|
83
|
-
url.
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
for (const [key, val] of newParams.entries()) {
|
|
87
|
-
url.searchParams.append(key, val);
|
|
88
|
-
}
|
|
85
|
+
if (url.search && existsRedirect.isQueryStringPreserved) {
|
|
86
|
+
const targetQueryString = (_a = target[1]) !== null && _a !== void 0 ? _a : '';
|
|
87
|
+
url.search = '?' + new URLSearchParams(`${url.search}&${targetQueryString}`).toString();
|
|
89
88
|
}
|
|
89
|
+
else if (target[1]) {
|
|
90
|
+
url.search = '?' + target[1];
|
|
91
|
+
}
|
|
92
|
+
else {
|
|
93
|
+
url.search = '';
|
|
94
|
+
}
|
|
95
|
+
const prepareNewURL = new URL(`${target[0]}${url.search}`, url.origin);
|
|
96
|
+
url.href = prepareNewURL.href;
|
|
97
|
+
url.pathname = prepareNewURL.pathname;
|
|
98
|
+
url.search = prepareNewURL.search;
|
|
99
|
+
url.locale = req.nextUrl.locale;
|
|
90
100
|
}
|
|
91
|
-
const redirectUrl = decodeURIComponent(url.href);
|
|
92
101
|
/** return Response redirect with http code of redirect type **/
|
|
93
102
|
switch (existsRedirect.redirectType) {
|
|
94
|
-
case site_1.REDIRECT_TYPE_301:
|
|
95
|
-
return
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
case site_1.
|
|
101
|
-
return server_1.NextResponse.
|
|
102
|
-
|
|
103
|
-
statusText: 'Found',
|
|
104
|
-
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
105
|
-
});
|
|
106
|
-
case site_1.REDIRECT_TYPE_SERVER_TRANSFER:
|
|
107
|
-
return server_1.NextResponse.rewrite(redirectUrl, res);
|
|
103
|
+
case site_1.REDIRECT_TYPE_301: {
|
|
104
|
+
return this.createRedirectResponse(url, res, 301, 'Moved Permanently');
|
|
105
|
+
}
|
|
106
|
+
case site_1.REDIRECT_TYPE_302: {
|
|
107
|
+
return this.createRedirectResponse(url, res, 302, 'Found');
|
|
108
|
+
}
|
|
109
|
+
case site_1.REDIRECT_TYPE_SERVER_TRANSFER: {
|
|
110
|
+
return this.rewrite(url.href, req, res || server_1.NextResponse.next());
|
|
111
|
+
}
|
|
108
112
|
default:
|
|
109
113
|
return res || server_1.NextResponse.next();
|
|
110
114
|
}
|
|
@@ -149,29 +153,140 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
|
|
|
149
153
|
getExistsRedirect(req, siteName) {
|
|
150
154
|
return __awaiter(this, void 0, void 0, function* () {
|
|
151
155
|
const redirects = yield this.redirectsService.fetchRedirects(siteName);
|
|
152
|
-
const
|
|
153
|
-
const targetQS = req.nextUrl.search || '';
|
|
156
|
+
const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
|
|
154
157
|
const language = this.getLanguage(req);
|
|
155
158
|
const modifyRedirects = structuredClone(redirects);
|
|
156
159
|
return modifyRedirects.length
|
|
157
160
|
? modifyRedirects.find((redirect) => {
|
|
161
|
+
// Modify the redirect pattern to ignore the language prefix in the path
|
|
158
162
|
redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
|
|
163
|
+
// Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
|
|
159
164
|
redirect.pattern = `/^\/${redirect.pattern
|
|
160
|
-
.replace(/^\/|\/$/g, '')
|
|
161
|
-
.replace(/^\^\/|\/\$$/g, '')
|
|
162
|
-
.replace(/^\^|\$$/g, '')
|
|
163
|
-
.replace(/(?<!\\)\?/g, '\\?')
|
|
164
|
-
.replace(/\$\/gi$/g, '')}[\/]?$/
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
165
|
+
.replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
|
|
166
|
+
.replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
|
|
167
|
+
.replace(/^\^|\$$/g, '') // Further cleans up anchors
|
|
168
|
+
.replace(/(?<!\\)\?/g, '\\?') // Escapes question marks in the pattern
|
|
169
|
+
.replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
|
|
170
|
+
/**
|
|
171
|
+
* This line checks whether the current URL query string (and all its possible permutations)
|
|
172
|
+
* matches the redirect pattern.
|
|
173
|
+
*
|
|
174
|
+
* Query parameters in URLs can come in different orders, but logically they represent the
|
|
175
|
+
* same information (e.g., "key1=value1&key2=value2" is the same as "key2=value2&key1=value1").
|
|
176
|
+
* To account for this, the method `isPermutedQueryMatch` generates all possible permutations
|
|
177
|
+
* of the query parameters and checks if any of those permutations match the regex pattern for the redirect.
|
|
178
|
+
*
|
|
179
|
+
* NOTE: This fix is specifically implemented for Netlify, where query parameters are sometimes
|
|
180
|
+
* automatically sorted, which can cause issues with matching redirects if the order of query
|
|
181
|
+
* parameters is important. By checking every possible permutation, we ensure that redirects
|
|
182
|
+
* work correctly on Netlify despite this behavior.
|
|
183
|
+
*
|
|
184
|
+
* It passes several pieces of information to the function:
|
|
185
|
+
* 1. `pathname`: The normalized URL path without query parameters (e.g., '/about').
|
|
186
|
+
* 2. `queryString`: The current query string from the URL, which will be permuted and matched (e.g., '?key1=value1&key2=value2').
|
|
187
|
+
* 3. `pattern`: The regex pattern for the redirect that we are trying to match against the URL (e.g., '/about?key1=value1').
|
|
188
|
+
* 4. `locale`: The locale part of the URL (if any), which helps support multilingual URLs.
|
|
189
|
+
*
|
|
190
|
+
* If one of the permutations of the query string matches the redirect pattern, the function
|
|
191
|
+
* returns the matched query string, which is stored in `matchedQueryString`. If no match is found,
|
|
192
|
+
* it returns `undefined`. The `matchedQueryString` is later used to indicate whether the query
|
|
193
|
+
* string contributed to a successful redirect match.
|
|
194
|
+
*/
|
|
195
|
+
const matchedQueryString = this.isPermutedQueryMatch({
|
|
196
|
+
pathname: targetURL,
|
|
197
|
+
queryString: targetQS,
|
|
198
|
+
pattern: redirect.pattern,
|
|
199
|
+
locale,
|
|
200
|
+
});
|
|
201
|
+
// Save the matched query string (if found) into the redirect object
|
|
202
|
+
redirect.matchedQueryString = matchedQueryString || '';
|
|
203
|
+
// Return the redirect if the URL path or any query string permutation matches the pattern
|
|
204
|
+
return (((0, regex_parser_1.default)(redirect.pattern).test(targetURL) ||
|
|
205
|
+
(0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
|
|
206
|
+
matchedQueryString) &&
|
|
207
|
+
(redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
|
|
172
208
|
})
|
|
173
209
|
: undefined;
|
|
174
210
|
});
|
|
175
211
|
}
|
|
212
|
+
/**
|
|
213
|
+
* When a user clicks on a link generated by the Link component from next/link,
|
|
214
|
+
* Next.js adds special parameters in the route called path.
|
|
215
|
+
* This method removes these special parameters.
|
|
216
|
+
* @param {NextURL} url
|
|
217
|
+
* @returns {string} normalize url
|
|
218
|
+
*/
|
|
219
|
+
normalizeUrl(url) {
|
|
220
|
+
if (!url.search) {
|
|
221
|
+
return url;
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* Prepare special parameters for exclusion.
|
|
225
|
+
*/
|
|
226
|
+
const splittedPathname = url.pathname
|
|
227
|
+
.split('/')
|
|
228
|
+
.filter((route) => route)
|
|
229
|
+
.map((route) => `path=${route}`);
|
|
230
|
+
/**
|
|
231
|
+
* Remove special parameters(Next.JS)
|
|
232
|
+
* Example: /about/contact/us
|
|
233
|
+
* When a user clicks on this link, Next.js should generate a link for the middleware, formatted like this:
|
|
234
|
+
* http://host/about/contact/us?path=about&path=contact&path=us
|
|
235
|
+
*/
|
|
236
|
+
const newQueryString = url.search
|
|
237
|
+
.replace(/^\?/, '')
|
|
238
|
+
.split('&')
|
|
239
|
+
.filter((param) => {
|
|
240
|
+
if (!splittedPathname.includes(param)) {
|
|
241
|
+
return param;
|
|
242
|
+
}
|
|
243
|
+
return false;
|
|
244
|
+
})
|
|
245
|
+
.join('&');
|
|
246
|
+
const newUrl = new URL(`${url.pathname}?${newQueryString}`, url.origin);
|
|
247
|
+
url.search = newUrl.search;
|
|
248
|
+
url.pathname = newUrl.pathname;
|
|
249
|
+
url.href = newUrl.href;
|
|
250
|
+
return url;
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* Helper function to create a redirect response and remove the x-middleware-next header.
|
|
254
|
+
* @param {NextURL} url The URL to redirect to.
|
|
255
|
+
* @param {Response} res The response object.
|
|
256
|
+
* @param {number} status The HTTP status code of the redirect.
|
|
257
|
+
* @param {string} statusText The status text of the redirect.
|
|
258
|
+
* @returns {NextResponse<unknown>} The redirect response.
|
|
259
|
+
*/
|
|
260
|
+
createRedirectResponse(url, res, status, statusText) {
|
|
261
|
+
const redirect = server_1.NextResponse.redirect(url, {
|
|
262
|
+
status,
|
|
263
|
+
statusText,
|
|
264
|
+
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
265
|
+
});
|
|
266
|
+
if (res === null || res === void 0 ? void 0 : res.headers) {
|
|
267
|
+
redirect.headers.delete('x-middleware-next');
|
|
268
|
+
redirect.headers.delete('x-middleware-rewrite');
|
|
269
|
+
}
|
|
270
|
+
return redirect;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
* Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
|
|
274
|
+
* It constructs all possible query parameter permutations and tests them against the pattern.
|
|
275
|
+
* @param {Object} params - The parameters for the URL match.
|
|
276
|
+
* @param {string} params.pathname - The current URL pathname.
|
|
277
|
+
* @param {string} params.queryString - The current URL query string.
|
|
278
|
+
* @param {string} params.pattern - The regex pattern to test the constructed URLs against.
|
|
279
|
+
* @param {string} [params.locale] - The locale prefix to include in the URL if present.
|
|
280
|
+
* @returns {string | undefined} - return query string if any of the query permutations match the provided pattern, undefined otherwise.
|
|
281
|
+
*/
|
|
282
|
+
isPermutedQueryMatch({ pathname, queryString, pattern, locale, }) {
|
|
283
|
+
const paramsArray = Array.from(new URLSearchParams(queryString).entries());
|
|
284
|
+
const listOfPermuted = (0, utils_1.getPermutations)(paramsArray).map((permutation) => '?' + permutation.map(([key, value]) => `${key}=${value}`).join('&'));
|
|
285
|
+
const normalizedPath = pathname.replace(/\/*$/gi, '');
|
|
286
|
+
return listOfPermuted.find((query) => [
|
|
287
|
+
(0, regex_parser_1.default)(pattern).test(`${normalizedPath}${query}`),
|
|
288
|
+
(0, regex_parser_1.default)(pattern).test(`/${locale}${normalizedPath}${query}`),
|
|
289
|
+
].some(Boolean));
|
|
290
|
+
}
|
|
176
291
|
}
|
|
177
292
|
exports.RedirectsMiddleware = RedirectsMiddleware;
|
|
@@ -12,13 +12,15 @@ var __rest = (this && this.__rest) || function (s, e) {
|
|
|
12
12
|
import { mediaApi } from '@sitecore-jss/sitecore-jss/media';
|
|
13
13
|
import PropTypes from 'prop-types';
|
|
14
14
|
import React from 'react';
|
|
15
|
-
import { getEEMarkup, withFieldMetadata, } from '@sitecore-jss/sitecore-jss-react';
|
|
15
|
+
import { getEEMarkup, withFieldMetadata, SitecoreContextReactContext, } from '@sitecore-jss/sitecore-jss-react';
|
|
16
16
|
import Image from 'next/image';
|
|
17
17
|
import { withEmptyFieldEditingComponent } from '@sitecore-jss/sitecore-jss-react';
|
|
18
18
|
import { DefaultEmptyFieldEditingComponentImage } from '@sitecore-jss/sitecore-jss-react';
|
|
19
|
-
import { isFieldValueEmpty } from '@sitecore-jss/sitecore-jss/layout';
|
|
19
|
+
import { isFieldValueEmpty, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
|
|
20
20
|
export const NextImage = withFieldMetadata(withEmptyFieldEditingComponent((_a) => {
|
|
21
|
+
var _b;
|
|
21
22
|
var { editable = true, imageParams, field, mediaUrlPrefix, fill, priority } = _a, otherProps = __rest(_a, ["editable", "imageParams", "field", "mediaUrlPrefix", "fill", "priority"]);
|
|
23
|
+
const sitecoreContext = React.useContext(SitecoreContextReactContext);
|
|
22
24
|
// next handles src and we use a custom loader,
|
|
23
25
|
// throw error if these are present
|
|
24
26
|
if (otherProps.src) {
|
|
@@ -40,8 +42,11 @@ export const NextImage = withFieldMetadata(withEmptyFieldEditingComponent((_a) =
|
|
|
40
42
|
if (!img) {
|
|
41
43
|
return null;
|
|
42
44
|
}
|
|
45
|
+
// disable image optimization for Edit and Preview, but preserve original value if true
|
|
46
|
+
const unoptimized = otherProps.unoptimized ||
|
|
47
|
+
((_b = sitecoreContext.context) === null || _b === void 0 ? void 0 : _b.pageState) !== LayoutServicePageState.Normal;
|
|
43
48
|
const attrs = Object.assign(Object.assign(Object.assign({}, img), otherProps), { fill,
|
|
44
|
-
priority, src: mediaApi.updateImageUrl(img.src, imageParams, mediaUrlPrefix) });
|
|
49
|
+
priority, src: mediaApi.updateImageUrl(img.src, imageParams, mediaUrlPrefix), unoptimized });
|
|
45
50
|
const imageProps = Object.assign(Object.assign({}, attrs), {
|
|
46
51
|
// force replace /media with /jssmedia in src since we _know_ we will be adding a 'mw' query string parameter
|
|
47
52
|
// this is required for Sitecore media API resizing to work properly
|
|
@@ -9,4 +9,4 @@ export const EDITING_PASS_THROUGH_HEADERS = ['authorization', 'cookie'];
|
|
|
9
9
|
/**
|
|
10
10
|
* Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
|
|
11
11
|
*/
|
|
12
|
-
export const EDITING_ALLOWED_ORIGINS = ['https://pages
|
|
12
|
+
export const EDITING_ALLOWED_ORIGINS = ['https://pages.sitecorecloud.io'];
|
|
@@ -216,10 +216,10 @@ export class MetadataHandler {
|
|
|
216
216
|
version: query.sc_version,
|
|
217
217
|
editMode: EditMode.Metadata,
|
|
218
218
|
pageState: query.mode,
|
|
219
|
+
layoutKind: query.sc_layoutKind,
|
|
219
220
|
},
|
|
220
221
|
// Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
|
|
221
222
|
{
|
|
222
|
-
path: query.route,
|
|
223
223
|
maxAge: 3,
|
|
224
224
|
});
|
|
225
225
|
// Cookies with the SameSite=Lax policy set by Next.js setPreviewData function causes CORS issue
|
package/dist/esm/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
|
|
1
|
+
export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, MemoryCacheClient, } from '@sitecore-jss/sitecore-jss';
|
|
2
2
|
export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, getContentStylesheetLink, EditMode, } from '@sitecore-jss/sitecore-jss/layout';
|
|
3
3
|
export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
|
|
4
4
|
export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
|
|
@@ -19,5 +19,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
|
|
|
19
19
|
export { FEaaSWrapper };
|
|
20
20
|
export { BYOCWrapper };
|
|
21
21
|
export { ComponentBuilder } from './ComponentBuilder';
|
|
22
|
-
export { Context } from './context';
|
|
23
22
|
export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { debug } from '@sitecore-jss/sitecore-jss';
|
|
2
|
+
export { MiddlewareBase } from './middleware';
|
|
2
3
|
export { RedirectsMiddleware } from './redirects-middleware';
|
|
3
4
|
export { PersonalizeMiddleware } from './personalize-middleware';
|
|
4
5
|
export { MultisiteMiddleware } from './multisite-middleware';
|
|
@@ -11,7 +11,8 @@ import { NextResponse } from 'next/server';
|
|
|
11
11
|
import { GraphQLPersonalizeService, getPersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from '@sitecore-jss/sitecore-jss/personalize';
|
|
12
12
|
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
13
13
|
import { MiddlewareBase } from './middleware';
|
|
14
|
-
import {
|
|
14
|
+
import { CloudSDK } from '@sitecore-cloudsdk/core/server';
|
|
15
|
+
import { personalize } from '@sitecore-cloudsdk/personalize/server';
|
|
15
16
|
/**
|
|
16
17
|
* Middleware / handler to support Sitecore Personalize
|
|
17
18
|
*/
|
|
@@ -133,13 +134,15 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
133
134
|
}
|
|
134
135
|
initPersonalizeServer({ hostname, siteName, request, response, }) {
|
|
135
136
|
return __awaiter(this, void 0, void 0, function* () {
|
|
136
|
-
yield
|
|
137
|
+
yield CloudSDK(request, response, {
|
|
137
138
|
sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
|
|
138
139
|
sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
|
|
139
140
|
siteName,
|
|
140
141
|
cookieDomain: hostname,
|
|
141
142
|
enableServerCookie: true,
|
|
142
|
-
})
|
|
143
|
+
})
|
|
144
|
+
.addPersonalize({ enablePersonalizeCookie: true })
|
|
145
|
+
.initialize();
|
|
143
146
|
});
|
|
144
147
|
}
|
|
145
148
|
personalize({ params, friendlyId, language, timeout, variantIds, }, request) {
|
|
@@ -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 regexParser from 'regex-parser';
|
|
11
|
-
import { NextResponse } from 'next/server';
|
|
12
|
-
import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
|
|
13
10
|
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
11
|
+
import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
|
|
12
|
+
import { getPermutations } from '@sitecore-jss/sitecore-jss/utils';
|
|
13
|
+
import { NextResponse } from 'next/server';
|
|
14
|
+
import regexParser from 'regex-parser';
|
|
14
15
|
import { MiddlewareBase } from './middleware';
|
|
15
16
|
const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
|
|
16
17
|
const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
|
|
@@ -37,6 +38,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
|
|
|
37
38
|
hostname,
|
|
38
39
|
});
|
|
39
40
|
const createResponse = () => __awaiter(this, void 0, void 0, function* () {
|
|
41
|
+
var _a;
|
|
40
42
|
if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
|
|
41
43
|
debug.redirects('skipped (redirects middleware is disabled)');
|
|
42
44
|
return res || NextResponse.next();
|
|
@@ -57,48 +59,50 @@ export class RedirectsMiddleware extends MiddlewareBase {
|
|
|
57
59
|
!(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
|
|
58
60
|
existsRedirect.target.includes(hostname))) {
|
|
59
61
|
existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
|
|
62
|
+
req.nextUrl.locale = site.language;
|
|
60
63
|
}
|
|
61
|
-
const url = req.nextUrl.clone();
|
|
64
|
+
const url = this.normalizeUrl(req.nextUrl.clone());
|
|
62
65
|
if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
|
|
63
66
|
url.href = existsRedirect.target;
|
|
64
67
|
}
|
|
65
68
|
else {
|
|
66
|
-
const source = `${url.pathname}${
|
|
67
|
-
url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
|
|
69
|
+
const source = `${url.pathname.replace(/\/*$/gi, '')}${existsRedirect.matchedQueryString}`;
|
|
68
70
|
const urlFirstPart = existsRedirect.target.split('/')[1];
|
|
69
71
|
if (this.locales.includes(urlFirstPart)) {
|
|
70
|
-
|
|
72
|
+
req.nextUrl.locale = urlFirstPart;
|
|
71
73
|
existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
|
|
72
74
|
}
|
|
73
75
|
const target = source
|
|
74
76
|
.replace(regexParser(existsRedirect.pattern), existsRedirect.target)
|
|
75
77
|
.replace(/^\/\//, '/')
|
|
76
78
|
.split('?');
|
|
77
|
-
url.
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
for (const [key, val] of newParams.entries()) {
|
|
81
|
-
url.searchParams.append(key, val);
|
|
82
|
-
}
|
|
79
|
+
if (url.search && existsRedirect.isQueryStringPreserved) {
|
|
80
|
+
const targetQueryString = (_a = target[1]) !== null && _a !== void 0 ? _a : '';
|
|
81
|
+
url.search = '?' + new URLSearchParams(`${url.search}&${targetQueryString}`).toString();
|
|
83
82
|
}
|
|
83
|
+
else if (target[1]) {
|
|
84
|
+
url.search = '?' + target[1];
|
|
85
|
+
}
|
|
86
|
+
else {
|
|
87
|
+
url.search = '';
|
|
88
|
+
}
|
|
89
|
+
const prepareNewURL = new URL(`${target[0]}${url.search}`, url.origin);
|
|
90
|
+
url.href = prepareNewURL.href;
|
|
91
|
+
url.pathname = prepareNewURL.pathname;
|
|
92
|
+
url.search = prepareNewURL.search;
|
|
93
|
+
url.locale = req.nextUrl.locale;
|
|
84
94
|
}
|
|
85
|
-
const redirectUrl = decodeURIComponent(url.href);
|
|
86
95
|
/** return Response redirect with http code of redirect type **/
|
|
87
96
|
switch (existsRedirect.redirectType) {
|
|
88
|
-
case REDIRECT_TYPE_301:
|
|
89
|
-
return
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
case
|
|
95
|
-
return
|
|
96
|
-
|
|
97
|
-
statusText: 'Found',
|
|
98
|
-
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
99
|
-
});
|
|
100
|
-
case REDIRECT_TYPE_SERVER_TRANSFER:
|
|
101
|
-
return NextResponse.rewrite(redirectUrl, res);
|
|
97
|
+
case REDIRECT_TYPE_301: {
|
|
98
|
+
return this.createRedirectResponse(url, res, 301, 'Moved Permanently');
|
|
99
|
+
}
|
|
100
|
+
case REDIRECT_TYPE_302: {
|
|
101
|
+
return this.createRedirectResponse(url, res, 302, 'Found');
|
|
102
|
+
}
|
|
103
|
+
case REDIRECT_TYPE_SERVER_TRANSFER: {
|
|
104
|
+
return this.rewrite(url.href, req, res || NextResponse.next());
|
|
105
|
+
}
|
|
102
106
|
default:
|
|
103
107
|
return res || NextResponse.next();
|
|
104
108
|
}
|
|
@@ -143,28 +147,139 @@ export class RedirectsMiddleware extends MiddlewareBase {
|
|
|
143
147
|
getExistsRedirect(req, siteName) {
|
|
144
148
|
return __awaiter(this, void 0, void 0, function* () {
|
|
145
149
|
const redirects = yield this.redirectsService.fetchRedirects(siteName);
|
|
146
|
-
const
|
|
147
|
-
const targetQS = req.nextUrl.search || '';
|
|
150
|
+
const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
|
|
148
151
|
const language = this.getLanguage(req);
|
|
149
152
|
const modifyRedirects = structuredClone(redirects);
|
|
150
153
|
return modifyRedirects.length
|
|
151
154
|
? modifyRedirects.find((redirect) => {
|
|
155
|
+
// Modify the redirect pattern to ignore the language prefix in the path
|
|
152
156
|
redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
|
|
157
|
+
// Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
|
|
153
158
|
redirect.pattern = `/^\/${redirect.pattern
|
|
154
|
-
.replace(/^\/|\/$/g, '')
|
|
155
|
-
.replace(/^\^\/|\/\$$/g, '')
|
|
156
|
-
.replace(/^\^|\$$/g, '')
|
|
157
|
-
.replace(/(?<!\\)\?/g, '\\?')
|
|
158
|
-
.replace(/\$\/gi$/g, '')}[\/]?$/
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
159
|
+
.replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
|
|
160
|
+
.replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
|
|
161
|
+
.replace(/^\^|\$$/g, '') // Further cleans up anchors
|
|
162
|
+
.replace(/(?<!\\)\?/g, '\\?') // Escapes question marks in the pattern
|
|
163
|
+
.replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
|
|
164
|
+
/**
|
|
165
|
+
* This line checks whether the current URL query string (and all its possible permutations)
|
|
166
|
+
* matches the redirect pattern.
|
|
167
|
+
*
|
|
168
|
+
* Query parameters in URLs can come in different orders, but logically they represent the
|
|
169
|
+
* same information (e.g., "key1=value1&key2=value2" is the same as "key2=value2&key1=value1").
|
|
170
|
+
* To account for this, the method `isPermutedQueryMatch` generates all possible permutations
|
|
171
|
+
* of the query parameters and checks if any of those permutations match the regex pattern for the redirect.
|
|
172
|
+
*
|
|
173
|
+
* NOTE: This fix is specifically implemented for Netlify, where query parameters are sometimes
|
|
174
|
+
* automatically sorted, which can cause issues with matching redirects if the order of query
|
|
175
|
+
* parameters is important. By checking every possible permutation, we ensure that redirects
|
|
176
|
+
* work correctly on Netlify despite this behavior.
|
|
177
|
+
*
|
|
178
|
+
* It passes several pieces of information to the function:
|
|
179
|
+
* 1. `pathname`: The normalized URL path without query parameters (e.g., '/about').
|
|
180
|
+
* 2. `queryString`: The current query string from the URL, which will be permuted and matched (e.g., '?key1=value1&key2=value2').
|
|
181
|
+
* 3. `pattern`: The regex pattern for the redirect that we are trying to match against the URL (e.g., '/about?key1=value1').
|
|
182
|
+
* 4. `locale`: The locale part of the URL (if any), which helps support multilingual URLs.
|
|
183
|
+
*
|
|
184
|
+
* If one of the permutations of the query string matches the redirect pattern, the function
|
|
185
|
+
* returns the matched query string, which is stored in `matchedQueryString`. If no match is found,
|
|
186
|
+
* it returns `undefined`. The `matchedQueryString` is later used to indicate whether the query
|
|
187
|
+
* string contributed to a successful redirect match.
|
|
188
|
+
*/
|
|
189
|
+
const matchedQueryString = this.isPermutedQueryMatch({
|
|
190
|
+
pathname: targetURL,
|
|
191
|
+
queryString: targetQS,
|
|
192
|
+
pattern: redirect.pattern,
|
|
193
|
+
locale,
|
|
194
|
+
});
|
|
195
|
+
// Save the matched query string (if found) into the redirect object
|
|
196
|
+
redirect.matchedQueryString = matchedQueryString || '';
|
|
197
|
+
// Return the redirect if the URL path or any query string permutation matches the pattern
|
|
198
|
+
return ((regexParser(redirect.pattern).test(targetURL) ||
|
|
199
|
+
regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
|
|
200
|
+
matchedQueryString) &&
|
|
201
|
+
(redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
|
|
166
202
|
})
|
|
167
203
|
: undefined;
|
|
168
204
|
});
|
|
169
205
|
}
|
|
206
|
+
/**
|
|
207
|
+
* When a user clicks on a link generated by the Link component from next/link,
|
|
208
|
+
* Next.js adds special parameters in the route called path.
|
|
209
|
+
* This method removes these special parameters.
|
|
210
|
+
* @param {NextURL} url
|
|
211
|
+
* @returns {string} normalize url
|
|
212
|
+
*/
|
|
213
|
+
normalizeUrl(url) {
|
|
214
|
+
if (!url.search) {
|
|
215
|
+
return url;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Prepare special parameters for exclusion.
|
|
219
|
+
*/
|
|
220
|
+
const splittedPathname = url.pathname
|
|
221
|
+
.split('/')
|
|
222
|
+
.filter((route) => route)
|
|
223
|
+
.map((route) => `path=${route}`);
|
|
224
|
+
/**
|
|
225
|
+
* Remove special parameters(Next.JS)
|
|
226
|
+
* Example: /about/contact/us
|
|
227
|
+
* When a user clicks on this link, Next.js should generate a link for the middleware, formatted like this:
|
|
228
|
+
* http://host/about/contact/us?path=about&path=contact&path=us
|
|
229
|
+
*/
|
|
230
|
+
const newQueryString = url.search
|
|
231
|
+
.replace(/^\?/, '')
|
|
232
|
+
.split('&')
|
|
233
|
+
.filter((param) => {
|
|
234
|
+
if (!splittedPathname.includes(param)) {
|
|
235
|
+
return param;
|
|
236
|
+
}
|
|
237
|
+
return false;
|
|
238
|
+
})
|
|
239
|
+
.join('&');
|
|
240
|
+
const newUrl = new URL(`${url.pathname}?${newQueryString}`, url.origin);
|
|
241
|
+
url.search = newUrl.search;
|
|
242
|
+
url.pathname = newUrl.pathname;
|
|
243
|
+
url.href = newUrl.href;
|
|
244
|
+
return url;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Helper function to create a redirect response and remove the x-middleware-next header.
|
|
248
|
+
* @param {NextURL} url The URL to redirect to.
|
|
249
|
+
* @param {Response} res The response object.
|
|
250
|
+
* @param {number} status The HTTP status code of the redirect.
|
|
251
|
+
* @param {string} statusText The status text of the redirect.
|
|
252
|
+
* @returns {NextResponse<unknown>} The redirect response.
|
|
253
|
+
*/
|
|
254
|
+
createRedirectResponse(url, res, status, statusText) {
|
|
255
|
+
const redirect = NextResponse.redirect(url, {
|
|
256
|
+
status,
|
|
257
|
+
statusText,
|
|
258
|
+
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
259
|
+
});
|
|
260
|
+
if (res === null || res === void 0 ? void 0 : res.headers) {
|
|
261
|
+
redirect.headers.delete('x-middleware-next');
|
|
262
|
+
redirect.headers.delete('x-middleware-rewrite');
|
|
263
|
+
}
|
|
264
|
+
return redirect;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
|
|
268
|
+
* It constructs all possible query parameter permutations and tests them against the pattern.
|
|
269
|
+
* @param {Object} params - The parameters for the URL match.
|
|
270
|
+
* @param {string} params.pathname - The current URL pathname.
|
|
271
|
+
* @param {string} params.queryString - The current URL query string.
|
|
272
|
+
* @param {string} params.pattern - The regex pattern to test the constructed URLs against.
|
|
273
|
+
* @param {string} [params.locale] - The locale prefix to include in the URL if present.
|
|
274
|
+
* @returns {string | undefined} - return query string if any of the query permutations match the provided pattern, undefined otherwise.
|
|
275
|
+
*/
|
|
276
|
+
isPermutedQueryMatch({ pathname, queryString, pattern, locale, }) {
|
|
277
|
+
const paramsArray = Array.from(new URLSearchParams(queryString).entries());
|
|
278
|
+
const listOfPermuted = getPermutations(paramsArray).map((permutation) => '?' + permutation.map(([key, value]) => `${key}=${value}`).join('&'));
|
|
279
|
+
const normalizedPath = pathname.replace(/\/*$/gi, '');
|
|
280
|
+
return listOfPermuted.find((query) => [
|
|
281
|
+
regexParser(pattern).test(`${normalizedPath}${query}`),
|
|
282
|
+
regexParser(pattern).test(`/${locale}${normalizedPath}${query}`),
|
|
283
|
+
].some(Boolean));
|
|
284
|
+
}
|
|
170
285
|
}
|