@sitecore-content-sdk/nextjs 1.3.0-canary.9 → 1.4.0-canary.2

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 (234) hide show
  1. package/README.md +11 -11
  2. package/dist/cjs/client/index.js +10 -10
  3. package/dist/cjs/client/models.js +2 -2
  4. package/dist/cjs/client/sitecore-nextjs-client.js +160 -156
  5. package/dist/cjs/components/BYOCWrapper.js +31 -30
  6. package/dist/cjs/components/ComponentPropsContext.js +66 -59
  7. package/dist/cjs/components/FEaaSWrapper.js +33 -32
  8. package/dist/cjs/components/Link.js +117 -90
  9. package/dist/cjs/components/NextImage.js +66 -62
  10. package/dist/cjs/components/Placeholder.js +55 -50
  11. package/dist/cjs/components/RichText.js +133 -128
  12. package/dist/cjs/config/define-config.js +26 -25
  13. package/dist/cjs/config/index.js +5 -5
  14. package/dist/cjs/config-cli/define-cli-config.js +40 -39
  15. package/dist/cjs/config-cli/index.js +5 -5
  16. package/dist/cjs/editing/codegen/import-map.js +129 -118
  17. package/dist/cjs/editing/codegen/index.js +6 -6
  18. package/dist/cjs/editing/constants.js +10 -10
  19. package/dist/cjs/editing/editing-config-middleware.js +70 -69
  20. package/dist/cjs/editing/editing-render-middleware.js +145 -144
  21. package/dist/cjs/editing/feaas-render-middleware.js +102 -101
  22. package/dist/cjs/editing/index.js +19 -19
  23. package/dist/cjs/editing/render-middleware.js +46 -46
  24. package/dist/cjs/editing/utils.js +260 -257
  25. package/dist/cjs/index.js +132 -131
  26. package/dist/cjs/middleware/app-router-multisite-middleware.js +41 -20
  27. package/dist/cjs/middleware/index.js +30 -30
  28. package/dist/cjs/middleware/locale-middleware.js +85 -84
  29. package/dist/cjs/middleware/middleware.js +195 -192
  30. package/dist/cjs/middleware/multisite-middleware.js +141 -118
  31. package/dist/cjs/middleware/personalize-middleware.js +240 -236
  32. package/dist/cjs/middleware/redirects-middleware.js +323 -297
  33. package/dist/cjs/middleware/robots-middleware.js +45 -44
  34. package/dist/cjs/middleware/sitemap-middleware.js +50 -49
  35. package/dist/cjs/monitoring/healthcheck-middleware.js +31 -30
  36. package/dist/cjs/monitoring/index.js +5 -5
  37. package/dist/cjs/route-handler/editing-config-route-handler.js +110 -106
  38. package/dist/cjs/route-handler/editing-render-route-handler.js +270 -165
  39. package/dist/cjs/route-handler/index.js +11 -11
  40. package/dist/cjs/route-handler/robots-route-handler.js +69 -68
  41. package/dist/cjs/route-handler/sitemap-route-handler.js +66 -65
  42. package/dist/cjs/search/index.js +17 -0
  43. package/dist/cjs/services/component-props-service.js +142 -138
  44. package/dist/cjs/sharedTypes/component-props.js +2 -2
  45. package/dist/cjs/sharedTypes/sitecore-page-props.js +2 -2
  46. package/dist/cjs/site/index.js +5 -5
  47. package/dist/cjs/tools/codegen/import-map.js +15 -0
  48. package/dist/cjs/tools/component-props.loader.js +95 -95
  49. package/dist/cjs/tools/generate-map.js +317 -317
  50. package/dist/cjs/tools/index.js +14 -13
  51. package/dist/cjs/tools/templating/byoc-component.js +36 -36
  52. package/dist/cjs/tools/templating/constants.js +7 -7
  53. package/dist/cjs/tools/templating/default-component.js +35 -35
  54. package/dist/cjs/tools/templating/utils.js +200 -0
  55. package/dist/cjs/utils/index.js +14 -14
  56. package/dist/cjs/utils/utils.js +82 -73
  57. package/dist/esm/client/index.js +2 -2
  58. package/dist/esm/client/models.js +1 -1
  59. package/dist/esm/client/sitecore-nextjs-client.js +156 -152
  60. package/dist/esm/components/BYOCWrapper.js +27 -26
  61. package/dist/esm/components/ComponentPropsContext.js +28 -21
  62. package/dist/esm/components/FEaaSWrapper.js +29 -28
  63. package/dist/esm/components/Link.js +78 -51
  64. package/dist/esm/components/NextImage.js +60 -56
  65. package/dist/esm/components/Placeholder.js +18 -13
  66. package/dist/esm/components/RichText.js +96 -91
  67. package/dist/esm/config/define-config.js +21 -20
  68. package/dist/esm/config/index.js +1 -1
  69. package/dist/esm/config-cli/define-cli-config.js +36 -35
  70. package/dist/esm/config-cli/index.js +1 -1
  71. package/dist/esm/editing/codegen/import-map.js +92 -81
  72. package/dist/esm/editing/codegen/index.js +1 -1
  73. package/dist/esm/editing/constants.js +7 -7
  74. package/dist/esm/editing/editing-config-middleware.js +66 -65
  75. package/dist/esm/editing/editing-render-middleware.js +141 -140
  76. package/dist/esm/editing/feaas-render-middleware.js +98 -97
  77. package/dist/esm/editing/index.js +6 -6
  78. package/dist/esm/editing/render-middleware.js +42 -42
  79. package/dist/esm/editing/utils.js +246 -243
  80. package/dist/esm/index.js +25 -25
  81. package/dist/esm/middleware/app-router-multisite-middleware.js +37 -16
  82. package/dist/esm/middleware/index.js +11 -11
  83. package/dist/esm/middleware/locale-middleware.js +81 -80
  84. package/dist/esm/middleware/middleware.js +189 -186
  85. package/dist/esm/middleware/multisite-middleware.js +137 -114
  86. package/dist/esm/middleware/personalize-middleware.js +236 -232
  87. package/dist/esm/middleware/redirects-middleware.js +316 -290
  88. package/dist/esm/middleware/robots-middleware.js +41 -40
  89. package/dist/esm/middleware/sitemap-middleware.js +46 -45
  90. package/dist/esm/monitoring/healthcheck-middleware.js +27 -26
  91. package/dist/esm/monitoring/index.js +1 -1
  92. package/dist/esm/route-handler/editing-config-route-handler.js +106 -102
  93. package/dist/esm/route-handler/editing-render-route-handler.js +265 -160
  94. package/dist/esm/route-handler/index.js +4 -4
  95. package/dist/esm/route-handler/robots-route-handler.js +65 -64
  96. package/dist/esm/route-handler/sitemap-route-handler.js +63 -62
  97. package/dist/esm/search/index.js +1 -0
  98. package/dist/esm/services/component-props-service.js +135 -131
  99. package/dist/esm/sharedTypes/component-props.js +1 -1
  100. package/dist/esm/sharedTypes/sitecore-page-props.js +1 -1
  101. package/dist/esm/site/index.js +1 -1
  102. package/dist/esm/tools/codegen/import-map.js +11 -0
  103. package/dist/esm/tools/component-props.loader.js +59 -59
  104. package/dist/esm/tools/generate-map.js +279 -279
  105. package/dist/esm/tools/index.js +3 -2
  106. package/dist/esm/tools/templating/byoc-component.js +30 -30
  107. package/dist/esm/tools/templating/constants.js +4 -4
  108. package/dist/esm/tools/templating/default-component.js +29 -29
  109. package/dist/esm/tools/templating/utils.js +190 -0
  110. package/dist/esm/utils/index.js +3 -3
  111. package/dist/esm/utils/utils.js +74 -65
  112. package/package.json +87 -13
  113. package/search.d.ts +1 -0
  114. package/types/client/index.d.ts +3 -2
  115. package/types/client/index.d.ts.map +1 -0
  116. package/types/client/models.d.ts +9 -8
  117. package/types/client/models.d.ts.map +1 -0
  118. package/types/client/sitecore-nextjs-client.d.ts +68 -63
  119. package/types/client/sitecore-nextjs-client.d.ts.map +1 -0
  120. package/types/components/BYOCWrapper.d.ts +16 -14
  121. package/types/components/BYOCWrapper.d.ts.map +1 -0
  122. package/types/components/ComponentPropsContext.d.ts +30 -18
  123. package/types/components/ComponentPropsContext.d.ts.map +1 -0
  124. package/types/components/FEaaSWrapper.d.ts +17 -15
  125. package/types/components/FEaaSWrapper.d.ts.map +1 -0
  126. package/types/components/Link.d.ts +25 -15
  127. package/types/components/Link.d.ts.map +1 -0
  128. package/types/components/NextImage.d.ts +11 -6
  129. package/types/components/NextImage.d.ts.map +1 -0
  130. package/types/components/Placeholder.d.ts +14 -8
  131. package/types/components/Placeholder.d.ts.map +1 -0
  132. package/types/components/RichText.d.ts +35 -25
  133. package/types/components/RichText.d.ts.map +1 -0
  134. package/types/config/define-config.d.ts +42 -38
  135. package/types/config/define-config.d.ts.map +1 -0
  136. package/types/config/index.d.ts +2 -1
  137. package/types/config/index.d.ts.map +1 -0
  138. package/types/config-cli/define-cli-config.d.ts +10 -8
  139. package/types/config-cli/define-cli-config.d.ts.map +1 -0
  140. package/types/config-cli/index.d.ts +2 -1
  141. package/types/config-cli/index.d.ts.map +1 -0
  142. package/types/editing/codegen/import-map.d.ts +15 -3
  143. package/types/editing/codegen/import-map.d.ts.map +1 -0
  144. package/types/editing/codegen/index.d.ts +3 -2
  145. package/types/editing/codegen/index.d.ts.map +1 -0
  146. package/types/editing/constants.d.ts +8 -7
  147. package/types/editing/constants.d.ts.map +1 -0
  148. package/types/editing/editing-config-middleware.d.ts +37 -31
  149. package/types/editing/editing-config-middleware.d.ts.map +1 -0
  150. package/types/editing/editing-render-middleware.d.ts +47 -44
  151. package/types/editing/editing-render-middleware.d.ts.map +1 -0
  152. package/types/editing/feaas-render-middleware.d.ts +35 -32
  153. package/types/editing/feaas-render-middleware.d.ts.map +1 -0
  154. package/types/editing/index.d.ts +7 -6
  155. package/types/editing/index.d.ts.map +1 -0
  156. package/types/editing/render-middleware.d.ts +26 -25
  157. package/types/editing/render-middleware.d.ts.map +1 -0
  158. package/types/editing/utils.d.ts +110 -106
  159. package/types/editing/utils.d.ts.map +1 -0
  160. package/types/index.d.ts +25 -24
  161. package/types/index.d.ts.map +1 -0
  162. package/types/middleware/app-router-multisite-middleware.d.ts +28 -13
  163. package/types/middleware/app-router-multisite-middleware.d.ts.map +1 -0
  164. package/types/middleware/index.d.ts +12 -11
  165. package/types/middleware/index.d.ts.map +1 -0
  166. package/types/middleware/locale-middleware.d.ts +35 -32
  167. package/types/middleware/locale-middleware.d.ts.map +1 -0
  168. package/types/middleware/middleware.d.ts +135 -127
  169. package/types/middleware/middleware.d.ts.map +1 -0
  170. package/types/middleware/multisite-middleware.d.ts +54 -37
  171. package/types/middleware/multisite-middleware.d.ts.map +1 -0
  172. package/types/middleware/personalize-middleware.d.ts +81 -65
  173. package/types/middleware/personalize-middleware.d.ts.map +1 -0
  174. package/types/middleware/redirects-middleware.d.ts +68 -65
  175. package/types/middleware/redirects-middleware.d.ts.map +1 -0
  176. package/types/middleware/robots-middleware.d.ts +15 -13
  177. package/types/middleware/robots-middleware.d.ts.map +1 -0
  178. package/types/middleware/sitemap-middleware.d.ts +16 -14
  179. package/types/middleware/sitemap-middleware.d.ts.map +1 -0
  180. package/types/monitoring/healthcheck-middleware.d.ts +14 -12
  181. package/types/monitoring/healthcheck-middleware.d.ts.map +1 -0
  182. package/types/monitoring/index.d.ts +2 -1
  183. package/types/monitoring/index.d.ts.map +1 -0
  184. package/types/route-handler/editing-config-route-handler.d.ts +30 -24
  185. package/types/route-handler/editing-config-route-handler.d.ts.map +1 -0
  186. package/types/route-handler/editing-render-route-handler.d.ts +33 -25
  187. package/types/route-handler/editing-render-route-handler.d.ts.map +1 -0
  188. package/types/route-handler/index.d.ts +5 -4
  189. package/types/route-handler/index.d.ts.map +1 -0
  190. package/types/route-handler/robots-route-handler.d.ts +30 -28
  191. package/types/route-handler/robots-route-handler.d.ts.map +1 -0
  192. package/types/route-handler/sitemap-route-handler.d.ts +30 -28
  193. package/types/route-handler/sitemap-route-handler.d.ts.map +1 -0
  194. package/types/search/index.d.ts +2 -0
  195. package/types/search/index.d.ts.map +1 -0
  196. package/types/services/component-props-service.d.ts +62 -57
  197. package/types/services/component-props-service.d.ts.map +1 -0
  198. package/types/sharedTypes/component-props.d.ts +62 -47
  199. package/types/sharedTypes/component-props.d.ts.map +1 -0
  200. package/types/sharedTypes/sitecore-page-props.d.ts +14 -9
  201. package/types/sharedTypes/sitecore-page-props.d.ts.map +1 -0
  202. package/types/site/index.d.ts +2 -1
  203. package/types/site/index.d.ts.map +1 -0
  204. package/types/tools/codegen/import-map.d.ts +10 -0
  205. package/types/tools/codegen/import-map.d.ts.map +1 -0
  206. package/types/tools/component-props.loader.d.ts +8 -7
  207. package/types/tools/component-props.loader.d.ts.map +1 -0
  208. package/types/tools/generate-map.d.ts +26 -24
  209. package/types/tools/generate-map.d.ts.map +1 -0
  210. package/types/tools/index.d.ts +4 -2
  211. package/types/tools/index.d.ts.map +1 -0
  212. package/types/tools/templating/byoc-component.d.ts +3 -2
  213. package/types/tools/templating/byoc-component.d.ts.map +1 -0
  214. package/types/tools/templating/constants.d.ts +5 -4
  215. package/types/tools/templating/constants.d.ts.map +1 -0
  216. package/types/tools/templating/default-component.d.ts +3 -2
  217. package/types/tools/templating/default-component.d.ts.map +1 -0
  218. package/types/tools/templating/utils.d.ts +44 -0
  219. package/types/tools/templating/utils.d.ts.map +1 -0
  220. package/types/utils/index.d.ts +4 -3
  221. package/types/utils/index.d.ts.map +1 -0
  222. package/types/utils/utils.d.ts +34 -24
  223. package/types/utils/utils.d.ts.map +1 -0
  224. package/client.js +0 -1
  225. package/codegen.js +0 -1
  226. package/config-cli.js +0 -1
  227. package/config.js +0 -1
  228. package/editing.js +0 -1
  229. package/middleware.js +0 -1
  230. package/monitoring.js +0 -1
  231. package/route-handler.js +0 -1
  232. package/site.js +0 -1
  233. package/tools.js +0 -1
  234. package/utils.js +0 -1
@@ -1,297 +1,323 @@
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
- var __importDefault = (this && this.__importDefault) || function (mod) {
12
- return (mod && mod.__esModule) ? mod : { "default": mod };
13
- };
14
- Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.RedirectsMiddleware = void 0;
16
- const core_1 = require("@sitecore-content-sdk/core");
17
- const site_1 = require("@sitecore-content-sdk/core/site");
18
- const utils_1 = require("@sitecore-content-sdk/core/utils");
19
- const server_1 = require("next/server");
20
- const regex_parser_1 = __importDefault(require("regex-parser"));
21
- const middleware_1 = require("./middleware");
22
- const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
23
- const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
24
- /**
25
- * Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
26
- * compares with current url and redirects to target url
27
- */
28
- class RedirectsMiddleware extends middleware_1.MiddlewareBase {
29
- /**
30
- * @param {RedirectsMiddlewareConfig} [config] redirects middleware config
31
- */
32
- constructor(config) {
33
- var _a;
34
- super(config);
35
- this.config = config;
36
- this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
37
- if (!this.config.enabled) {
38
- core_1.debug.redirects('skipped (redirects middleware is disabled globally)');
39
- return res;
40
- }
41
- try {
42
- const pathname = req.nextUrl.pathname;
43
- const language = this.getLanguage(req, res);
44
- const hostname = this.getHostHeader(req) || this.defaultHostname;
45
- let site;
46
- const startTimestamp = Date.now();
47
- core_1.debug.redirects('redirects middleware start: %o', {
48
- pathname,
49
- language,
50
- hostname,
51
- });
52
- if (this.disabled(req, res)) {
53
- core_1.debug.redirects('skipped (redirects middleware is disabled)');
54
- return res;
55
- }
56
- const createResponse = () => __awaiter(this, void 0, void 0, function* () {
57
- var _a;
58
- if (this.isPreview(req)) {
59
- core_1.debug.redirects('skipped (preview)');
60
- return res;
61
- }
62
- // Skip prefetch requests from Next.js, which are not original client requests
63
- // as they load unnecessary requests that burden the redirects middleware with meaningless traffic
64
- if (this.isPrefetch(req)) {
65
- core_1.debug.redirects('skipped (prefetch)');
66
- res.headers.set('x-middleware-cache', 'no-cache');
67
- res.headers.set('Cache-Control', 'no-store, must-revalidate');
68
- return res;
69
- }
70
- site = this.getSite(req, res);
71
- // Find the redirect from result of RedirectService
72
- const existsRedirect = yield this.getExistsRedirect(req, site.name);
73
- if (!existsRedirect) {
74
- core_1.debug.redirects('skipped (redirect does not exist)');
75
- return res;
76
- }
77
- core_1.debug.redirects('Matched redirect rule: %o', { existsRedirect });
78
- // Find context site language and replace token
79
- if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
80
- !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
81
- existsRedirect.target.includes(hostname))) {
82
- existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
83
- req.nextUrl.locale = site.language;
84
- }
85
- const url = this.normalizeUrl(req.nextUrl.clone());
86
- // Redirect logic for external (absolute) URLS. To avoid locale stripping: use plain string for external URLs to prevent Next.js rewriting.
87
- if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
88
- return this.dispatchRedirect(existsRedirect.target, existsRedirect.redirectType, req, res, true);
89
- }
90
- else {
91
- const isUrl = (0, utils_1.isRegexOrUrl)(existsRedirect.pattern) === 'url';
92
- const targetParts = existsRedirect.target.split('/');
93
- const urlFirstPart = targetParts[1];
94
- if (this.locales.includes(urlFirstPart)) {
95
- req.nextUrl.locale = urlFirstPart;
96
- existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
97
- }
98
- const targetSegments = isUrl
99
- ? existsRedirect.target.split('?')
100
- : url.pathname.replace(/\/*$/gi, '') + existsRedirect.matchedQueryString;
101
- const [targetPath, targetQueryString] = isUrl
102
- ? targetSegments
103
- : targetSegments
104
- .replace((0, regex_parser_1.default)(existsRedirect.pattern), existsRedirect.target)
105
- .replace(/^\/\//, '/')
106
- .split('?');
107
- const mergedQueryString = existsRedirect.isQueryStringPreserved
108
- ? (0, utils_1.mergeURLSearchParams)(new URLSearchParams((_a = url.search) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQueryString || ''))
109
- : targetQueryString || '';
110
- const prepareNewURL = new URL(`${targetPath}${mergedQueryString ? '?' + mergedQueryString : ''}`, url.origin);
111
- url.href = prepareNewURL.href;
112
- url.pathname = prepareNewURL.pathname;
113
- url.search = prepareNewURL.search;
114
- url.locale = req.nextUrl.locale;
115
- }
116
- /** return Response redirect with http code of redirect type */
117
- return this.dispatchRedirect(url, existsRedirect.redirectType, req, res, false);
118
- });
119
- const response = yield createResponse();
120
- core_1.debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
121
- redirected: response.redirected,
122
- status: response.status,
123
- url: response.url,
124
- headers: this.extractDebugHeaders(response.headers),
125
- });
126
- return response;
127
- }
128
- catch (error) {
129
- console.log('Redirect middleware failed:');
130
- console.log(error);
131
- return res;
132
- }
133
- });
134
- const graphQLOptions = {
135
- api: {
136
- edge: {
137
- contextId: this.config.contextId,
138
- clientContextId: this.config.clientContextId,
139
- edgeUrl: this.config.edgeUrl,
140
- },
141
- },
142
- };
143
- // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
144
- // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
145
- this.redirectsService =
146
- (_a = this.config.redirectsService) !== null && _a !== void 0 ? _a : new site_1.RedirectsService(Object.assign(Object.assign({}, config), { clientFactory: this.getClientFactory(graphQLOptions), fetch: fetch }));
147
- this.locales = config.locales;
148
- }
149
- /**
150
- * Method returns RedirectInfo when matches
151
- * @param {NextRequest} req request
152
- * @param {string} siteName site name
153
- * @returns Promise<RedirectInfo | undefined>
154
- * @private
155
- */
156
- getExistsRedirect(req, siteName) {
157
- return __awaiter(this, void 0, void 0, function* () {
158
- const { pathname: incomingURL, search: incomingQS = '' } = this.normalizeUrl(req.nextUrl.clone());
159
- const locale = this.getLanguage(req);
160
- const normalizedPath = incomingURL.replace(/\/*$/gi, '').toLowerCase();
161
- const redirects = yield this.redirectsService.fetchRedirects(siteName);
162
- const language = this.getLanguage(req);
163
- const modifyRedirects = structuredClone(redirects);
164
- let matchedQueryString;
165
- const localePath = `/${locale.toLowerCase()}${normalizedPath}`;
166
- return modifyRedirects.length
167
- ? modifyRedirects.find((redirect) => {
168
- // process static URL (non-regex) rules
169
- if ((0, utils_1.isRegexOrUrl)(redirect.pattern) === 'url') {
170
- const urlArray = redirect.pattern.endsWith('/')
171
- ? redirect.pattern.slice(0, -1).split('?')
172
- : redirect.pattern.split('?');
173
- const patternQS = urlArray[1];
174
- let patternPath = urlArray[0].toLowerCase();
175
- // nextjs routes are case-sensitive, but locales should be compared case-insensitively
176
- const patternParts = patternPath.split('/');
177
- const maybeLocale = patternParts[1].toLowerCase();
178
- // case insensitive lookup of locales
179
- if (new RegExp(this.locales.join('|'), 'i').test(maybeLocale)) {
180
- patternPath = patternPath.replace(`/${patternParts[1]}`, `/${maybeLocale}`);
181
- }
182
- return ((patternPath === localePath || patternPath === normalizedPath) &&
183
- (!patternQS ||
184
- (0, utils_1.areURLSearchParamsEqual)(new URLSearchParams(patternQS), new URLSearchParams(incomingQS))));
185
- }
186
- // process regex rules
187
- // Modify the redirect pattern to ignore the language prefix in the path
188
- // And escapes non-special "?" characters in a string or regex.
189
- redirect.pattern = (0, utils_1.escapeNonSpecialQuestionMarks)(redirect.pattern.replace(new RegExp(`^[^]?/${language}/`, 'gi'), ''));
190
- // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
191
- redirect.pattern = `/^\/${redirect.pattern
192
- .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
193
- .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
194
- .replace(/^\^|\$$/g, '') // Further cleans up anchors
195
- .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
196
- // Redirect pattern matches the full incoming URL with query string present
197
- matchedQueryString = [
198
- (0, regex_parser_1.default)(redirect.pattern).test(`/${localePath}${incomingQS}`),
199
- (0, regex_parser_1.default)(redirect.pattern).test(`${normalizedPath}${incomingQS}`),
200
- ].some(Boolean)
201
- ? incomingQS
202
- : undefined;
203
- // Save the matched query string (if found) into the redirect object
204
- redirect.matchedQueryString = matchedQueryString || '';
205
- return (!!((0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${incomingURL}`) ||
206
- (0, regex_parser_1.default)(redirect.pattern).test(incomingURL) ||
207
- matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
208
- })
209
- : undefined;
210
- });
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.toLowerCase()}?${newQueryString}`, url.origin);
247
- url.search = newUrl.search;
248
- url.pathname = newUrl.pathname.toLocaleLowerCase();
249
- url.href = newUrl.href;
250
- return url;
251
- }
252
- /**
253
- * Helper function to dispatch a redirect or rewrite based on the redirect type.
254
- * @param {NextURL | string} target The final target to redirect/rewrite to.
255
- * @param {string} type One of `REDIRECT_TYPE_301`, `REDIRECT_TYPE_302`, or `REDIRECT_TYPE_SERVER_TRANSFER`.
256
- * @param {NextRequest} req The incoming request.
257
- * @param {NextResponse} res The current response (used for header cleanup / carry-over).
258
- * @param {boolean} isExternal Set to `true` when `target` is an external absolute URL (e.g. `https://…`).
259
- * Passed through to `rewrite` so it can skip locale/basePath stripping for externals.
260
- * @returns {NextResponse} The redirect/rewrite response, or `res` if the type is not recognized.
261
- */
262
- dispatchRedirect(target, type, req, res, isExternal = false) {
263
- switch (type) {
264
- case site_1.REDIRECT_TYPE_301:
265
- return this.createRedirectResponse(target, res, 301, 'Moved Permanently');
266
- case site_1.REDIRECT_TYPE_302:
267
- return this.createRedirectResponse(target, res, 302, 'Found');
268
- case site_1.REDIRECT_TYPE_SERVER_TRANSFER:
269
- // rewrite expects a string; unwrap NextURL if needed
270
- return this.rewrite(typeof target === 'string' ? target : target.href, req, res, isExternal);
271
- default:
272
- return res;
273
- }
274
- }
275
- /**
276
- * Helper function to create a redirect response and remove the x-middleware-next header.
277
- * @param {NextURL | string} url The URL to redirect to.
278
- * @param {Response} res The response object.
279
- * @param {number} status The HTTP status code of the redirect.
280
- * @param {string} statusText The status text of the redirect.
281
- * @returns {NextResponse<unknown>} The redirect response.
282
- */
283
- createRedirectResponse(url, res, status, statusText) {
284
- const redirect = server_1.NextResponse.redirect(url, {
285
- status,
286
- statusText,
287
- headers: res === null || res === void 0 ? void 0 : res.headers,
288
- });
289
- if (res === null || res === void 0 ? void 0 : res.headers) {
290
- redirect.headers.delete('x-middleware-next');
291
- redirect.headers.delete('x-middleware-rewrite');
292
- redirect.headers.delete(middleware_1.REWRITE_HEADER_NAME);
293
- }
294
- return redirect;
295
- }
296
- }
297
- exports.RedirectsMiddleware = RedirectsMiddleware;
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
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.RedirectsMiddleware = void 0;
16
+ const core_1 = require("@sitecore-content-sdk/core");
17
+ const site_1 = require("@sitecore-content-sdk/core/site");
18
+ const utils_1 = require("@sitecore-content-sdk/core/utils");
19
+ const server_1 = require("next/server");
20
+ const regex_parser_1 = __importDefault(require("regex-parser"));
21
+ const middleware_1 = require("./middleware");
22
+ const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
23
+ const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
24
+ /**
25
+ * Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
26
+ * compares with current url and redirects to target url
27
+ * @public
28
+ */
29
+ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
30
+ /**
31
+ * @param {RedirectsMiddlewareConfig} [config] redirects middleware config
32
+ */
33
+ constructor(config) {
34
+ var _a;
35
+ super(config);
36
+ this.config = config;
37
+ this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
38
+ if (!this.config.enabled) {
39
+ core_1.debug.redirects('skipped (redirects middleware is disabled globally)');
40
+ return res;
41
+ }
42
+ try {
43
+ const pathname = req.nextUrl.pathname;
44
+ const language = this.getLanguage(req, res);
45
+ const hostname = this.getHostHeader(req) || this.defaultHostname;
46
+ let site;
47
+ const startTimestamp = Date.now();
48
+ core_1.debug.redirects('redirects middleware start: %o', {
49
+ pathname,
50
+ language,
51
+ hostname,
52
+ });
53
+ if (this.disabled(req, res)) {
54
+ core_1.debug.redirects('skipped (redirects middleware is disabled)');
55
+ return res;
56
+ }
57
+ const isAppRouterRequest = this.isAppRouter(res);
58
+ const createResponse = () => __awaiter(this, void 0, void 0, function* () {
59
+ var _a;
60
+ if (this.isPreview(req)) {
61
+ core_1.debug.redirects('skipped (preview)');
62
+ return res;
63
+ }
64
+ // Skip prefetch requests from Next.js, which are not original client requests
65
+ // as they load unnecessary requests that burden the redirects middleware with meaningless traffic
66
+ if (this.isPrefetch(req)) {
67
+ core_1.debug.redirects('skipped (prefetch)');
68
+ res.headers.set('x-middleware-cache', 'no-cache');
69
+ res.headers.set('Cache-Control', 'no-store, must-revalidate');
70
+ return res;
71
+ }
72
+ site = this.getSite(req, res);
73
+ // Find the redirect from result of RedirectService
74
+ const existsRedirect = yield this.getExistsRedirect(req, site.name);
75
+ if (!existsRedirect) {
76
+ core_1.debug.redirects('skipped (redirect does not exist)');
77
+ return res;
78
+ }
79
+ core_1.debug.redirects('Matched redirect rule: %o', { existsRedirect });
80
+ // Find context site language and replace token
81
+ if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
82
+ !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
83
+ existsRedirect.target.includes(hostname))) {
84
+ existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
85
+ if (!isAppRouterRequest) {
86
+ req.nextUrl.locale = site.language;
87
+ }
88
+ }
89
+ const url = this.normalizeUrl(req.nextUrl.clone());
90
+ // Redirect logic for external (absolute) URLS. To avoid locale stripping: use plain string for external URLs to prevent Next.js rewriting.
91
+ if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
92
+ // Perform variable substitution for absolute URLs
93
+ let finalTarget = existsRedirect.target;
94
+ if ((0, utils_1.isRegexOrUrl)(existsRedirect.pattern) === 'regex') {
95
+ const matched = url.pathname
96
+ .replace(/\/*$/gi, '')
97
+ .match((0, regex_parser_1.default)(existsRedirect.pattern));
98
+ if (matched) {
99
+ finalTarget = existsRedirect.target.replace(/\$(\d+)/g, (_, index) => {
100
+ return matched[parseInt(index, 10)] || '';
101
+ });
102
+ }
103
+ }
104
+ return this.dispatchRedirect(finalTarget, existsRedirect.redirectType, req, res, true);
105
+ }
106
+ else {
107
+ const isUrl = (0, utils_1.isRegexOrUrl)(existsRedirect.pattern) === 'url';
108
+ const targetParts = existsRedirect.target.split('/');
109
+ const urlFirstPart = targetParts[1];
110
+ if (this.locales.includes(urlFirstPart)) {
111
+ if (!isAppRouterRequest) {
112
+ req.nextUrl.locale = urlFirstPart;
113
+ }
114
+ existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
115
+ }
116
+ const targetSegments = isUrl
117
+ ? existsRedirect.target.split('?')
118
+ : url.pathname.replace(/\/*$/gi, '') + existsRedirect.matchedQueryString;
119
+ const [targetPath, targetQueryString] = isUrl
120
+ ? targetSegments
121
+ : targetSegments
122
+ .replace((0, regex_parser_1.default)(existsRedirect.pattern), existsRedirect.target)
123
+ .replace(/^\/\//, '/')
124
+ .split('?');
125
+ const mergedQueryString = existsRedirect.isQueryStringPreserved
126
+ ? (0, utils_1.mergeURLSearchParams)(new URLSearchParams((_a = url.search) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQueryString || ''))
127
+ : targetQueryString || '';
128
+ const prepareNewURL = new URL(`${targetPath}${mergedQueryString ? '?' + mergedQueryString : ''}`, url.origin);
129
+ url.href = prepareNewURL.href;
130
+ url.pathname = prepareNewURL.pathname;
131
+ url.search = prepareNewURL.search;
132
+ if (!isAppRouterRequest) {
133
+ url.locale = req.nextUrl.locale;
134
+ }
135
+ }
136
+ /** return Response redirect with http code of redirect type */
137
+ return this.dispatchRedirect(url, existsRedirect.redirectType, req, res, false);
138
+ });
139
+ const response = yield createResponse();
140
+ core_1.debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
141
+ redirected: response.redirected,
142
+ status: response.status,
143
+ url: response.url,
144
+ headers: this.extractDebugHeaders(response.headers),
145
+ });
146
+ return response;
147
+ }
148
+ catch (error) {
149
+ console.log('Redirect middleware failed:');
150
+ console.log(error);
151
+ return res;
152
+ }
153
+ });
154
+ const graphQLOptions = {
155
+ api: Object.assign({ edge: {
156
+ contextId: this.config.contextId,
157
+ clientContextId: this.config.clientContextId,
158
+ edgeUrl: this.config.edgeUrl,
159
+ } }, (this.config.apiHost && this.config.apiKey
160
+ ? {
161
+ local: {
162
+ apiHost: this.config.apiHost,
163
+ apiKey: this.config.apiKey,
164
+ path: this.config.path,
165
+ },
166
+ }
167
+ : {})),
168
+ };
169
+ // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
170
+ // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
171
+ this.redirectsService =
172
+ (_a = this.config.redirectsService) !== null && _a !== void 0 ? _a : new site_1.RedirectsService(Object.assign(Object.assign({}, config), { clientFactory: this.getClientFactory(graphQLOptions), fetch: fetch }));
173
+ this.locales = config.locales;
174
+ }
175
+ /**
176
+ * Method returns RedirectInfo when matches
177
+ * @param {NextRequest} req request
178
+ * @param {string} siteName site name
179
+ * @returns Promise<RedirectInfo | undefined>
180
+ * @private
181
+ */
182
+ getExistsRedirect(req, siteName) {
183
+ return __awaiter(this, void 0, void 0, function* () {
184
+ const { pathname: incomingURL, search: incomingQS = '' } = this.normalizeUrl(req.nextUrl.clone());
185
+ const locale = this.getLanguage(req);
186
+ const normalizedPath = incomingURL.replace(/\/*$/gi, '').toLowerCase();
187
+ const redirects = yield this.redirectsService.fetchRedirects(siteName);
188
+ const language = this.getLanguage(req);
189
+ const modifyRedirects = structuredClone(redirects);
190
+ let matchedQueryString;
191
+ const localePath = `/${locale.toLowerCase()}${normalizedPath}`;
192
+ return modifyRedirects.length
193
+ ? modifyRedirects.find((redirect) => {
194
+ // process static URL (non-regex) rules
195
+ if ((0, utils_1.isRegexOrUrl)(redirect.pattern) === 'url') {
196
+ const urlArray = redirect.pattern.endsWith('/')
197
+ ? redirect.pattern.slice(0, -1).split('?')
198
+ : redirect.pattern.split('?');
199
+ const patternQS = urlArray[1];
200
+ let patternPath = urlArray[0].toLowerCase();
201
+ // nextjs routes are case-sensitive, but locales should be compared case-insensitively
202
+ const patternParts = patternPath.split('/');
203
+ const maybeLocale = patternParts[1].toLowerCase();
204
+ // case insensitive lookup of locales
205
+ if (new RegExp(this.locales.join('|'), 'i').test(maybeLocale)) {
206
+ patternPath = patternPath.replace(`/${patternParts[1]}`, `/${maybeLocale}`);
207
+ }
208
+ return ((patternPath === localePath || patternPath === normalizedPath) &&
209
+ (!patternQS ||
210
+ (0, utils_1.areURLSearchParamsEqual)(new URLSearchParams(patternQS), new URLSearchParams(incomingQS))));
211
+ }
212
+ // process regex rules
213
+ // Modify the redirect pattern to ignore the language prefix in the path
214
+ // And escapes non-special "?" characters in a string or regex.
215
+ redirect.pattern = (0, utils_1.escapeNonSpecialQuestionMarks)(redirect.pattern.replace(new RegExp(`^[^]?/${language}/`, 'gi'), ''));
216
+ // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
217
+ redirect.pattern = `/^\/${redirect.pattern
218
+ .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
219
+ .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
220
+ .replace(/^\^|\$$/g, '') // Further cleans up anchors
221
+ .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
222
+ // Redirect pattern matches the full incoming URL with query string present
223
+ matchedQueryString = [
224
+ (0, regex_parser_1.default)(redirect.pattern).test(`/${localePath}${incomingQS}`),
225
+ (0, regex_parser_1.default)(redirect.pattern).test(`${normalizedPath}${incomingQS}`),
226
+ ].some(Boolean)
227
+ ? incomingQS
228
+ : undefined;
229
+ // Save the matched query string (if found) into the redirect object
230
+ redirect.matchedQueryString = matchedQueryString || '';
231
+ return (!!((0, regex_parser_1.default)(redirect.pattern).test(`/${req.nextUrl.locale}${incomingURL}`) ||
232
+ (0, regex_parser_1.default)(redirect.pattern).test(incomingURL) ||
233
+ matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
234
+ })
235
+ : undefined;
236
+ });
237
+ }
238
+ /**
239
+ * When a user clicks on a link generated by the Link component from next/link,
240
+ * Next.js adds special parameters in the route called path.
241
+ * This method removes these special parameters.
242
+ * @param {NextURL} url
243
+ * @returns {string} normalize url
244
+ */
245
+ normalizeUrl(url) {
246
+ if (!url.search) {
247
+ return url;
248
+ }
249
+ /**
250
+ * Prepare special parameters for exclusion.
251
+ */
252
+ const splittedPathname = url.pathname
253
+ .split('/')
254
+ .filter((route) => route)
255
+ .map((route) => `path=${route}`);
256
+ /**
257
+ * Remove special parameters(Next.JS)
258
+ * Example: /about/contact/us
259
+ * When a user clicks on this link, Next.js should generate a link for the middleware, formatted like this:
260
+ * http://host/about/contact/us?path=about&path=contact&path=us
261
+ */
262
+ const newQueryString = url.search
263
+ .replace(/^\?/, '')
264
+ .split('&')
265
+ .filter((param) => {
266
+ if (!splittedPathname.includes(param)) {
267
+ return param;
268
+ }
269
+ return false;
270
+ })
271
+ .join('&');
272
+ const newUrl = new URL(`${url.pathname.toLowerCase()}?${newQueryString}`, url.origin);
273
+ url.search = newUrl.search;
274
+ url.pathname = newUrl.pathname.toLocaleLowerCase();
275
+ url.href = newUrl.href;
276
+ return url;
277
+ }
278
+ /**
279
+ * Helper function to dispatch a redirect or rewrite based on the redirect type.
280
+ * @param {NextURL | string} target The final target to redirect/rewrite to.
281
+ * @param {string} type One of `REDIRECT_TYPE_301`, `REDIRECT_TYPE_302`, or `REDIRECT_TYPE_SERVER_TRANSFER`.
282
+ * @param {NextRequest} req The incoming request.
283
+ * @param {NextResponse} res The current response (used for header cleanup / carry-over).
284
+ * @param {boolean} isExternal Set to `true` when `target` is an external absolute URL (e.g. `https://…`).
285
+ * Passed through to `rewrite` so it can skip locale/basePath stripping for externals.
286
+ * @returns {NextResponse} The redirect/rewrite response, or `res` if the type is not recognized.
287
+ */
288
+ dispatchRedirect(target, type, req, res, isExternal = false) {
289
+ switch (type) {
290
+ case site_1.REDIRECT_TYPE_301:
291
+ return this.createRedirectResponse(target, res, 301, 'Moved Permanently');
292
+ case site_1.REDIRECT_TYPE_302:
293
+ return this.createRedirectResponse(target, res, 302, 'Found');
294
+ case site_1.REDIRECT_TYPE_SERVER_TRANSFER:
295
+ // rewrite expects a string; unwrap NextURL if needed
296
+ return this.rewrite(typeof target === 'string' ? target : target.href, req, res, isExternal);
297
+ default:
298
+ return res;
299
+ }
300
+ }
301
+ /**
302
+ * Helper function to create a redirect response and remove the x-middleware-next header.
303
+ * @param {NextURL | string} url The URL to redirect to.
304
+ * @param {Response} res The response object.
305
+ * @param {number} status The HTTP status code of the redirect.
306
+ * @param {string} statusText The status text of the redirect.
307
+ * @returns {NextResponse<unknown>} The redirect response.
308
+ */
309
+ createRedirectResponse(url, res, status, statusText) {
310
+ const redirect = server_1.NextResponse.redirect(url, {
311
+ status,
312
+ statusText,
313
+ headers: res === null || res === void 0 ? void 0 : res.headers,
314
+ });
315
+ if (res === null || res === void 0 ? void 0 : res.headers) {
316
+ redirect.headers.delete('x-middleware-next');
317
+ redirect.headers.delete('x-middleware-rewrite');
318
+ redirect.headers.delete(middleware_1.REWRITE_HEADER_NAME);
319
+ }
320
+ return redirect;
321
+ }
322
+ }
323
+ exports.RedirectsMiddleware = RedirectsMiddleware;