@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.9 → 21.7.1-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.
- package/README.md +1 -4
- package/dist/cjs/components/NextImage.js +2 -10
- package/dist/cjs/components/RichText.js +2 -2
- package/dist/cjs/context/context.js +30 -10
- package/dist/cjs/editing/editing-config-middleware.js +49 -0
- package/dist/cjs/editing/editing-render-middleware.js +3 -16
- package/dist/cjs/editing/feaas-render-middleware.js +87 -0
- package/dist/cjs/editing/index.js +5 -1
- package/dist/cjs/editing/render-middleware.js +27 -0
- package/dist/cjs/graphql/index.js +2 -1
- package/dist/cjs/index.js +6 -2
- package/dist/cjs/middleware/multisite-middleware.js +7 -1
- package/dist/cjs/middleware/personalize-middleware.js +1 -1
- package/dist/cjs/middleware/redirects-middleware.js +24 -10
- package/dist/cjs/utils/utils.js +6 -18
- package/dist/esm/components/NextImage.js +1 -8
- package/dist/esm/components/RichText.js +2 -2
- package/dist/esm/context/context.js +30 -10
- package/dist/esm/editing/editing-config-middleware.js +45 -0
- package/dist/esm/editing/editing-render-middleware.js +4 -17
- package/dist/esm/editing/feaas-render-middleware.js +83 -0
- package/dist/esm/editing/index.js +2 -0
- package/dist/esm/editing/render-middleware.js +23 -0
- package/dist/esm/graphql/index.js +1 -1
- package/dist/esm/index.js +5 -3
- package/dist/esm/middleware/multisite-middleware.js +7 -1
- package/dist/esm/middleware/personalize-middleware.js +1 -1
- package/dist/esm/middleware/redirects-middleware.js +24 -10
- package/dist/esm/utils/utils.js +6 -15
- package/package.json +12 -13
- package/types/components/NextImage.d.ts +1 -2
- package/types/context/context.d.ts +13 -1
- package/types/editing/editing-config-middleware.d.ts +29 -0
- package/types/editing/editing-render-middleware.d.ts +2 -11
- package/types/editing/feaas-render-middleware.d.ts +32 -0
- package/types/editing/index.d.ts +2 -0
- package/types/editing/render-middleware.d.ts +15 -0
- package/types/graphql/index.d.ts +1 -1
- package/types/index.d.ts +5 -3
- package/types/middleware/multisite-middleware.d.ts +14 -0
- package/types/utils/utils.d.ts +1 -0
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { LayoutServicePageState } from '@sitecore-jss/sitecore-jss-react';
|
|
1
2
|
/**
|
|
2
3
|
* Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
|
|
3
4
|
*/
|
|
@@ -16,9 +17,27 @@ export class Context {
|
|
|
16
17
|
* Promises for the SDKs
|
|
17
18
|
*/
|
|
18
19
|
this.sdkPromises = {};
|
|
20
|
+
this.sdkErrors = {};
|
|
21
|
+
/**
|
|
22
|
+
* Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
|
|
23
|
+
*
|
|
24
|
+
* @param {string} name SDK name
|
|
25
|
+
* @returns initialized SDK
|
|
26
|
+
*/
|
|
27
|
+
this.getSDK = (name) => {
|
|
28
|
+
if (!this.sdkPromises[name]) {
|
|
29
|
+
return Promise.reject(`Unknown SDK '${String(name)}'`);
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
return this.sdkPromises[name].then((result) => {
|
|
33
|
+
return ((this.sdkErrors[name] && Promise.reject(this.sdkErrors[name])) || Promise.resolve(result));
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
};
|
|
19
37
|
this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
|
|
20
38
|
this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
|
|
21
39
|
this.siteName = props.siteName;
|
|
40
|
+
this.pageState = LayoutServicePageState.Normal;
|
|
22
41
|
}
|
|
23
42
|
init(props = {}) {
|
|
24
43
|
// Context and SDKs are initialized only once
|
|
@@ -28,20 +47,14 @@ export class Context {
|
|
|
28
47
|
if (props.siteName) {
|
|
29
48
|
this.siteName = props.siteName;
|
|
30
49
|
}
|
|
50
|
+
if (props.pageState) {
|
|
51
|
+
this.pageState = props.pageState;
|
|
52
|
+
}
|
|
31
53
|
// iterate over the SDKs and initialize them
|
|
32
54
|
for (const sdkName of Object.keys(this.props.sdks)) {
|
|
33
55
|
this.initSDK(sdkName);
|
|
34
56
|
}
|
|
35
57
|
}
|
|
36
|
-
/**
|
|
37
|
-
* Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
|
|
38
|
-
*
|
|
39
|
-
* @param {string} name SDK name
|
|
40
|
-
* @returns initialized SDK
|
|
41
|
-
*/
|
|
42
|
-
getSDK(name) {
|
|
43
|
-
return this.sdkPromises[name];
|
|
44
|
-
}
|
|
45
58
|
/**
|
|
46
59
|
* Initializes the Software Development Kit (SDK)
|
|
47
60
|
*
|
|
@@ -50,9 +63,16 @@ export class Context {
|
|
|
50
63
|
*/
|
|
51
64
|
initSDK(name) {
|
|
52
65
|
this.sdkPromises[name] = new Promise((resolve) => {
|
|
53
|
-
this.props.sdks[name]
|
|
66
|
+
this.props.sdks[name]
|
|
67
|
+
.init(this)
|
|
68
|
+
.then(() => {
|
|
54
69
|
this.sdks[name] = this.props.sdks[name].sdk;
|
|
55
70
|
resolve(this.sdks[name]);
|
|
71
|
+
})
|
|
72
|
+
.catch((e) => {
|
|
73
|
+
// if init rejects, we mark SDK as failed - so getSDK call would reject with a reason
|
|
74
|
+
this.sdkErrors[name] = e;
|
|
75
|
+
resolve(undefined);
|
|
56
76
|
});
|
|
57
77
|
});
|
|
58
78
|
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
import { QUERY_PARAM_EDITING_SECRET } from './constants';
|
|
11
|
+
import { getJssEditingSecret } from '../utils/utils';
|
|
12
|
+
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
13
|
+
/**
|
|
14
|
+
* Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
|
|
15
|
+
* provides configuration information to determine feature compatibility on Pages side.
|
|
16
|
+
*/
|
|
17
|
+
export class EditingConfigMiddleware {
|
|
18
|
+
/**
|
|
19
|
+
* @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
|
|
20
|
+
*/
|
|
21
|
+
constructor(config) {
|
|
22
|
+
this.config = config;
|
|
23
|
+
this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
24
|
+
const secret = _req.query[QUERY_PARAM_EDITING_SECRET];
|
|
25
|
+
if (secret !== getJssEditingSecret()) {
|
|
26
|
+
debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
|
|
27
|
+
return res.status(401).json({ message: 'Missing or invalid editing secret' });
|
|
28
|
+
}
|
|
29
|
+
const components = Array.isArray(this.config.components)
|
|
30
|
+
? this.config.components
|
|
31
|
+
: Array.from(this.config.components.keys());
|
|
32
|
+
return res.status(200).json({
|
|
33
|
+
components,
|
|
34
|
+
packages: this.config.metadata.packages,
|
|
35
|
+
});
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Gets the Next.js API route handler
|
|
40
|
+
* @returns middleware handler
|
|
41
|
+
*/
|
|
42
|
+
getHandler() {
|
|
43
|
+
return this.handler;
|
|
44
|
+
}
|
|
45
|
+
}
|
|
@@ -12,33 +12,20 @@ import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
|
|
|
12
12
|
import { EDITING_COMPONENT_ID, RenderingType } from '@sitecore-jss/sitecore-jss/layout';
|
|
13
13
|
import { parse } from 'node-html-parser';
|
|
14
14
|
import { editingDataService } from './editing-data-service';
|
|
15
|
-
import { QUERY_PARAM_EDITING_SECRET
|
|
15
|
+
import { QUERY_PARAM_EDITING_SECRET } from './constants';
|
|
16
16
|
import { getJssEditingSecret } from '../utils/utils';
|
|
17
|
+
import { RenderMiddlewareBase } from './render-middleware';
|
|
17
18
|
/**
|
|
18
19
|
* Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
|
|
19
20
|
* which is required for Sitecore editing support.
|
|
20
21
|
*/
|
|
21
|
-
export class EditingRenderMiddleware {
|
|
22
|
+
export class EditingRenderMiddleware extends RenderMiddlewareBase {
|
|
22
23
|
/**
|
|
23
24
|
* @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
|
|
24
25
|
*/
|
|
25
26
|
constructor(config) {
|
|
26
27
|
var _a, _b, _c, _d;
|
|
27
|
-
|
|
28
|
-
* Gets query parameters that should be passed along to subsequent requests
|
|
29
|
-
* @param query Object of query parameters from incoming URL
|
|
30
|
-
* @returns Object of approved query parameters
|
|
31
|
-
*/
|
|
32
|
-
this.getQueryParamsForPropagation = (query) => {
|
|
33
|
-
const params = {};
|
|
34
|
-
if (query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
|
|
35
|
-
params[QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
|
|
36
|
-
}
|
|
37
|
-
if (query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
|
|
38
|
-
params[QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
|
|
39
|
-
}
|
|
40
|
-
return params;
|
|
41
|
-
};
|
|
28
|
+
super();
|
|
42
29
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
43
30
|
var _e, _f;
|
|
44
31
|
const { method, query, body, headers } = req;
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
11
|
+
import { QUERY_PARAM_EDITING_SECRET } from './constants';
|
|
12
|
+
import { getJssEditingSecret } from '../utils/utils';
|
|
13
|
+
import { RenderMiddlewareBase } from './render-middleware';
|
|
14
|
+
/**
|
|
15
|
+
* Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
|
|
16
|
+
* which is required for Sitecore editing support.
|
|
17
|
+
*/
|
|
18
|
+
export class FEAASRenderMiddleware extends RenderMiddlewareBase {
|
|
19
|
+
/**
|
|
20
|
+
* @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
|
|
21
|
+
*/
|
|
22
|
+
constructor(config) {
|
|
23
|
+
var _a;
|
|
24
|
+
super();
|
|
25
|
+
this.config = config;
|
|
26
|
+
this.defaultPageUrl = '/feaas/render';
|
|
27
|
+
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
28
|
+
const { method, query, headers } = req;
|
|
29
|
+
const startTimestamp = Date.now();
|
|
30
|
+
debug.editing('feaas render middleware start: %o', {
|
|
31
|
+
method,
|
|
32
|
+
query,
|
|
33
|
+
headers,
|
|
34
|
+
});
|
|
35
|
+
if (method !== 'GET') {
|
|
36
|
+
debug.editing('invalid method - sent %s expected GET', method);
|
|
37
|
+
res.setHeader('Allow', 'GET');
|
|
38
|
+
return res.status(405).send(`<html><body>Invalid request method '${method}'</body></html>`);
|
|
39
|
+
}
|
|
40
|
+
// Validate secret
|
|
41
|
+
const secret = query[QUERY_PARAM_EDITING_SECRET];
|
|
42
|
+
if (secret !== getJssEditingSecret()) {
|
|
43
|
+
debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
|
|
44
|
+
return res.status(401).send('<html><body>Missing or invalid secret</body></html>');
|
|
45
|
+
}
|
|
46
|
+
try {
|
|
47
|
+
// Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
|
|
48
|
+
const params = this.getQueryParamsForPropagation(query);
|
|
49
|
+
// Enable Next.js Preview Mode
|
|
50
|
+
res.setPreviewData({});
|
|
51
|
+
const queryParams = new URLSearchParams();
|
|
52
|
+
for (const key in params) {
|
|
53
|
+
if ({}.hasOwnProperty.call(params, key)) {
|
|
54
|
+
queryParams.append(key, params[key]);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
// Pass "feaasSrc" in case a FEAASComponent is being requested
|
|
58
|
+
if (query.feaasSrc) {
|
|
59
|
+
queryParams.append('feaasSrc', query.feaasSrc);
|
|
60
|
+
}
|
|
61
|
+
const redirectUrl = this.pageUrl + (queryParams.toString() ? `?${queryParams.toString()}` : '');
|
|
62
|
+
debug.editing('redirecting to page route %s', redirectUrl);
|
|
63
|
+
debug.editing('feaas render middleware end in %dms', Date.now() - startTimestamp);
|
|
64
|
+
res.redirect(redirectUrl);
|
|
65
|
+
}
|
|
66
|
+
catch (err) {
|
|
67
|
+
const error = err;
|
|
68
|
+
console.info(
|
|
69
|
+
// eslint-disable-next-line quotes
|
|
70
|
+
"Hint: for non-standard server or Next.js route configurations, you may need to override the 'pageUrl' available on the 'FEAASRenderMiddleware' config.");
|
|
71
|
+
res.status(500).send(`<html><body>${error}</body></html>`);
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
this.pageUrl = (_a = config === null || config === void 0 ? void 0 : config.pageUrl) !== null && _a !== void 0 ? _a : this.defaultPageUrl;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Gets the Next.js API route handler
|
|
78
|
+
* @returns route handler
|
|
79
|
+
*/
|
|
80
|
+
getHandler() {
|
|
81
|
+
return this.handler;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
@@ -3,3 +3,5 @@ export { EditingDataMiddleware } from './editing-data-middleware';
|
|
|
3
3
|
export { EditingRenderMiddleware, } from './editing-render-middleware';
|
|
4
4
|
export { BasicEditingDataService, ServerlessEditingDataService, editingDataService, } from './editing-data-service';
|
|
5
5
|
export { VercelEditingDataCache } from './vercel-editing-data-cache';
|
|
6
|
+
export { FEAASRenderMiddleware } from './feaas-render-middleware';
|
|
7
|
+
export { EditingConfigMiddleware, } from './editing-config-middleware';
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { QUERY_PARAM_PROTECTION_BYPASS_SITECORE, QUERY_PARAM_PROTECTION_BYPASS_VERCEL, } from './constants';
|
|
2
|
+
/**
|
|
3
|
+
* Base class for middleware that handles pages and components rendering in Sitecore Editors.
|
|
4
|
+
*/
|
|
5
|
+
export class RenderMiddlewareBase {
|
|
6
|
+
constructor() {
|
|
7
|
+
/**
|
|
8
|
+
* Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
|
|
9
|
+
* @param {Object} query Object of query parameters from incoming URL
|
|
10
|
+
* @returns Object of approved query parameters
|
|
11
|
+
*/
|
|
12
|
+
this.getQueryParamsForPropagation = (query) => {
|
|
13
|
+
const params = {};
|
|
14
|
+
if (query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
|
|
15
|
+
params[QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
|
|
16
|
+
}
|
|
17
|
+
if (query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
|
|
18
|
+
params[QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
|
|
19
|
+
}
|
|
20
|
+
return params;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export { GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
|
|
1
|
+
export { DefaultRetryStrategy, GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
|
package/dist/esm/index.js
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
export { constants, AxiosDataFetcher,
|
|
1
|
+
export { constants, AxiosDataFetcher,
|
|
2
|
+
/** @deprecated use import 'GraphQLClientError' from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
|
|
3
|
+
ClientError, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
|
|
2
4
|
// we will remove the root exports for these later
|
|
3
5
|
// we cannot mark exports as deprected directly, so we're using this hack instead
|
|
4
6
|
import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
|
|
@@ -20,7 +22,7 @@ const { GraphQLRequestClientDep: GraphQLRequestClient } = {
|
|
|
20
22
|
export { GraphQLRequestClient };
|
|
21
23
|
export { handleEditorFastRefresh, getPublicUrl };
|
|
22
24
|
export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
|
|
23
|
-
export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
|
|
25
|
+
export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, getContentStylesheetLink, } from '@sitecore-jss/sitecore-jss/layout';
|
|
24
26
|
export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
|
|
25
27
|
export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
|
|
26
28
|
export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
|
|
@@ -42,4 +44,4 @@ export { FEaaSWrapper };
|
|
|
42
44
|
export { BYOCWrapper };
|
|
43
45
|
export { ComponentBuilder } from './ComponentBuilder';
|
|
44
46
|
export { Context } from './context';
|
|
45
|
-
export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
|
|
47
|
+
export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, getComponentLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
|
|
@@ -49,8 +49,14 @@ export class MultisiteMiddleware extends MiddlewareBase {
|
|
|
49
49
|
siteName,
|
|
50
50
|
});
|
|
51
51
|
response = this.rewrite(rewritePath, req, response);
|
|
52
|
+
// default site cookie attributes
|
|
53
|
+
const defaultCookieAttributes = {
|
|
54
|
+
secure: true,
|
|
55
|
+
httpOnly: true,
|
|
56
|
+
sameSite: 'none',
|
|
57
|
+
};
|
|
52
58
|
// Share site name with the following executed middlewares
|
|
53
|
-
response.cookies.set(this.SITE_SYMBOL, siteName);
|
|
59
|
+
response.cookies.set(this.SITE_SYMBOL, siteName, defaultCookieAttributes);
|
|
54
60
|
debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
55
61
|
rewritePath,
|
|
56
62
|
siteName,
|
|
@@ -65,7 +65,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
65
65
|
response,
|
|
66
66
|
});
|
|
67
67
|
const params = this.getExperienceParams(req);
|
|
68
|
-
debug.personalize('executing experience for %s %
|
|
68
|
+
debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
|
|
69
69
|
let variantId;
|
|
70
70
|
// Execute targeted experience in Personalize SDK
|
|
71
71
|
// eslint-disable-next-line no-useless-catch
|
|
@@ -12,7 +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/, '
|
|
15
|
+
const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
|
|
16
|
+
const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
|
|
16
17
|
/**
|
|
17
18
|
* Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
|
|
18
19
|
* compares with current url and redirects to target url
|
|
@@ -52,25 +53,34 @@ export class RedirectsMiddleware extends MiddlewareBase {
|
|
|
52
53
|
return res || NextResponse.next();
|
|
53
54
|
}
|
|
54
55
|
// Find context site language and replace token
|
|
55
|
-
if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target)
|
|
56
|
+
if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
|
|
57
|
+
!(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
|
|
58
|
+
existsRedirect.target.includes(hostname))) {
|
|
56
59
|
existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
|
|
57
60
|
}
|
|
58
61
|
const url = req.nextUrl.clone();
|
|
59
|
-
|
|
60
|
-
if (absoluteUrlRegex.test(existsRedirect.target)) {
|
|
62
|
+
if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
|
|
61
63
|
url.href = existsRedirect.target;
|
|
62
|
-
url.locale = req.nextUrl.locale;
|
|
63
64
|
}
|
|
64
65
|
else {
|
|
66
|
+
const source = `${url.pathname}${url.search}`;
|
|
65
67
|
url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
|
|
66
68
|
const urlFirstPart = existsRedirect.target.split('/')[1];
|
|
67
69
|
if (this.locales.includes(urlFirstPart)) {
|
|
68
70
|
url.locale = urlFirstPart;
|
|
69
71
|
existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
|
|
70
72
|
}
|
|
71
|
-
|
|
73
|
+
const target = source
|
|
72
74
|
.replace(regexParser(existsRedirect.pattern), existsRedirect.target)
|
|
73
|
-
.replace(/^\/\//, '/')
|
|
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
|
+
}
|
|
83
|
+
}
|
|
74
84
|
}
|
|
75
85
|
const redirectUrl = decodeURIComponent(url.href);
|
|
76
86
|
/** return Response redirect with http code of redirect type **/
|
|
@@ -135,13 +145,17 @@ export class RedirectsMiddleware extends MiddlewareBase {
|
|
|
135
145
|
const redirects = yield this.redirectsService.fetchRedirects(siteName);
|
|
136
146
|
const tragetURL = req.nextUrl.pathname;
|
|
137
147
|
const targetQS = req.nextUrl.search || '';
|
|
138
|
-
|
|
139
|
-
|
|
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'), '');
|
|
140
153
|
redirect.pattern = `/^\/${redirect.pattern
|
|
141
154
|
.replace(/^\/|\/$/g, '')
|
|
142
155
|
.replace(/^\^\/|\/\$$/g, '')
|
|
143
156
|
.replace(/^\^|\$$/g, '')
|
|
144
|
-
.replace(
|
|
157
|
+
.replace(/(?<!\\)\?/g, '\\?')
|
|
158
|
+
.replace(/\$\/gi$/g, '')}[\/]?$/gi`;
|
|
145
159
|
return ((regexParser(redirect.pattern).test(tragetURL) ||
|
|
146
160
|
regexParser(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
|
|
147
161
|
regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
|
package/dist/esm/utils/utils.js
CHANGED
|
@@ -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.
|
|
@@ -7,27 +6,19 @@ import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/u
|
|
|
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.
|
|
9
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 = ''
|
|
10
10
|
*/
|
|
11
11
|
export const getPublicUrl = () => {
|
|
12
|
-
if (process.env.NETLIFY && process.env.DEPLOY_URL)
|
|
13
|
-
return process.env.DEPLOY_URL;
|
|
14
|
-
if (process.env.VERCEL_URL)
|
|
15
|
-
return `https://${process.env.VERCEL_URL}`;
|
|
16
12
|
let url = process.env.PUBLIC_URL;
|
|
17
13
|
if (url === undefined) {
|
|
18
|
-
|
|
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}`;
|
|
19
18
|
url = 'http://localhost:3000';
|
|
20
19
|
}
|
|
21
|
-
else {
|
|
22
|
-
try {
|
|
23
|
-
new URL(url);
|
|
24
|
-
}
|
|
25
|
-
catch (error) {
|
|
26
|
-
throw new Error(`The PUBLIC_URL environment variable '${url}' is not a valid URL.`);
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
20
|
// Ensure no trailing slash
|
|
30
|
-
return url.
|
|
21
|
+
return url.replace(/\/$/, '');
|
|
31
22
|
};
|
|
32
23
|
/**
|
|
33
24
|
* Since Sitecore editors do not support Fast Refresh:
|
package/package.json
CHANGED
|
@@ -1,21 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sitecore-jss/sitecore-jss-nextjs",
|
|
3
|
-
"version": "21.7.
|
|
3
|
+
"version": "21.7.1-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
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": ">=
|
|
18
|
-
"npm": ">=6"
|
|
17
|
+
"node": ">=18"
|
|
19
18
|
},
|
|
20
19
|
"author": {
|
|
21
20
|
"name": "Sitecore Corporation",
|
|
@@ -30,7 +29,7 @@
|
|
|
30
29
|
"url": "https://github.com/sitecore/jss/issues"
|
|
31
30
|
},
|
|
32
31
|
"devDependencies": {
|
|
33
|
-
"@sitecore-cloudsdk/personalize": "^0.1.
|
|
32
|
+
"@sitecore-cloudsdk/personalize": "^0.1.5",
|
|
34
33
|
"@types/chai": "^4.3.4",
|
|
35
34
|
"@types/chai-as-promised": "^7.1.5",
|
|
36
35
|
"@types/chai-string": "^1.4.2",
|
|
@@ -55,7 +54,7 @@
|
|
|
55
54
|
"eslint-plugin-react": "^7.32.1",
|
|
56
55
|
"jsdom": "^21.1.0",
|
|
57
56
|
"mocha": "^10.2.0",
|
|
58
|
-
"next": "^
|
|
57
|
+
"next": "^14.1.0",
|
|
59
58
|
"nock": "^13.3.0",
|
|
60
59
|
"nyc": "^15.1.0",
|
|
61
60
|
"react": "^18.2.0",
|
|
@@ -66,16 +65,16 @@
|
|
|
66
65
|
"typescript": "~4.9.4"
|
|
67
66
|
},
|
|
68
67
|
"peerDependencies": {
|
|
69
|
-
"@sitecore-cloudsdk/events": "^0.
|
|
70
|
-
"@sitecore-cloudsdk/personalize": "^0.
|
|
71
|
-
"next": "^
|
|
68
|
+
"@sitecore-cloudsdk/events": "^0.2.3",
|
|
69
|
+
"@sitecore-cloudsdk/personalize": "^0.2.3",
|
|
70
|
+
"next": "^14.1.0",
|
|
72
71
|
"react": "^18.2.0",
|
|
73
72
|
"react-dom": "^18.2.0"
|
|
74
73
|
},
|
|
75
74
|
"dependencies": {
|
|
76
|
-
"@sitecore-jss/sitecore-jss": "^21.7.
|
|
77
|
-
"@sitecore-jss/sitecore-jss-dev-tools": "^21.7.
|
|
78
|
-
"@sitecore-jss/sitecore-jss-react": "^21.7.
|
|
75
|
+
"@sitecore-jss/sitecore-jss": "^21.7.1-canary.1",
|
|
76
|
+
"@sitecore-jss/sitecore-jss-dev-tools": "^21.7.1-canary.1",
|
|
77
|
+
"@sitecore-jss/sitecore-jss-react": "^21.7.1-canary.1",
|
|
79
78
|
"@vercel/kv": "^0.2.1",
|
|
80
79
|
"node-html-parser": "^6.1.4",
|
|
81
80
|
"prop-types": "^15.8.1",
|
|
@@ -84,7 +83,7 @@
|
|
|
84
83
|
},
|
|
85
84
|
"description": "",
|
|
86
85
|
"types": "types/index.d.ts",
|
|
87
|
-
"gitHead": "
|
|
86
|
+
"gitHead": "fa7d3bc304fa37a80002ff4a8947d4f14beb1d31",
|
|
88
87
|
"files": [
|
|
89
88
|
"dist",
|
|
90
89
|
"types",
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
/// <reference types="@types/react" />
|
|
2
2
|
import React from 'react';
|
|
3
3
|
import { ImageProps } from '@sitecore-jss/sitecore-jss-react';
|
|
4
|
-
import {
|
|
4
|
+
import { ImageProps as NextImageProperties } from 'next/image';
|
|
5
5
|
type NextImageProps = Omit<ImageProps, 'media'> & Partial<NextImageProperties>;
|
|
6
|
-
export declare const sitecoreLoader: ImageLoader;
|
|
7
6
|
export declare const NextImage: React.FC<NextImageProps>;
|
|
8
7
|
export {};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { LayoutServicePageState } from '@sitecore-jss/sitecore-jss-react';
|
|
1
2
|
/**
|
|
2
3
|
* Software Development Kit (SDK) instance
|
|
3
4
|
*/
|
|
@@ -23,6 +24,10 @@ export interface ContextInitProps {
|
|
|
23
24
|
* Your Sitecore site name
|
|
24
25
|
*/
|
|
25
26
|
siteName?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Sitecore page state (normal, preview, edit)
|
|
29
|
+
*/
|
|
30
|
+
pageState?: LayoutServicePageState;
|
|
26
31
|
}
|
|
27
32
|
/**
|
|
28
33
|
* Configuration that is passed to the Context.
|
|
@@ -72,6 +77,10 @@ export declare class Context<SDKModules extends SDKModulesType> {
|
|
|
72
77
|
* The Sitecore site name
|
|
73
78
|
*/
|
|
74
79
|
siteName: string;
|
|
80
|
+
/**
|
|
81
|
+
* Sitecore page state (normal, preview, edit)
|
|
82
|
+
*/
|
|
83
|
+
pageState: LayoutServicePageState;
|
|
75
84
|
/**
|
|
76
85
|
* Software Development Kits (SDKs) to be initialized
|
|
77
86
|
*/
|
|
@@ -84,6 +93,9 @@ export declare class Context<SDKModules extends SDKModulesType> {
|
|
|
84
93
|
protected sdkPromises: {
|
|
85
94
|
[module in keyof SDKModules]?: Promise<SDKModules[module]['sdk']>;
|
|
86
95
|
};
|
|
96
|
+
protected sdkErrors: {
|
|
97
|
+
[module in keyof SDKModules]?: string;
|
|
98
|
+
};
|
|
87
99
|
constructor(props: ContextConfig<SDKModules>);
|
|
88
100
|
init(props?: ContextInitProps): void;
|
|
89
101
|
/**
|
|
@@ -92,7 +104,7 @@ export declare class Context<SDKModules extends SDKModulesType> {
|
|
|
92
104
|
* @param {string} name SDK name
|
|
93
105
|
* @returns initialized SDK
|
|
94
106
|
*/
|
|
95
|
-
getSDK<T extends keyof SDKModules>(name: T)
|
|
107
|
+
getSDK: <T extends keyof SDKModules>(name: T) => Promise<SDKModules[T]["sdk"]>;
|
|
96
108
|
/**
|
|
97
109
|
* Initializes the Software Development Kit (SDK)
|
|
98
110
|
*
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { NextApiRequest, NextApiResponse } from 'next';
|
|
2
|
+
import { Metadata } from '@sitecore-jss/sitecore-jss-dev-tools';
|
|
3
|
+
export type EditingConfigMiddlewareConfig = {
|
|
4
|
+
/**
|
|
5
|
+
* Components available in the application
|
|
6
|
+
*/
|
|
7
|
+
components: string[] | Map<string, unknown>;
|
|
8
|
+
/**
|
|
9
|
+
* Application metadata
|
|
10
|
+
*/
|
|
11
|
+
metadata: Metadata;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
|
|
15
|
+
* provides configuration information to determine feature compatibility on Pages side.
|
|
16
|
+
*/
|
|
17
|
+
export declare class EditingConfigMiddleware {
|
|
18
|
+
protected config: EditingConfigMiddlewareConfig;
|
|
19
|
+
/**
|
|
20
|
+
* @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
|
|
21
|
+
*/
|
|
22
|
+
constructor(config: EditingConfigMiddlewareConfig);
|
|
23
|
+
/**
|
|
24
|
+
* Gets the Next.js API route handler
|
|
25
|
+
* @returns middleware handler
|
|
26
|
+
*/
|
|
27
|
+
getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
|
|
28
|
+
private handler;
|
|
29
|
+
}
|
|
@@ -2,6 +2,7 @@ import { NextApiRequest, NextApiResponse } from 'next';
|
|
|
2
2
|
import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
|
|
3
3
|
import { EditingData } from './editing-data';
|
|
4
4
|
import { EditingDataService } from './editing-data-service';
|
|
5
|
+
import { RenderMiddlewareBase } from './render-middleware';
|
|
5
6
|
export interface EditingRenderMiddlewareConfig {
|
|
6
7
|
/**
|
|
7
8
|
* The `AxiosDataFetcher` instance to use for API requests.
|
|
@@ -41,7 +42,7 @@ export interface EditingRenderMiddlewareConfig {
|
|
|
41
42
|
* Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
|
|
42
43
|
* which is required for Sitecore editing support.
|
|
43
44
|
*/
|
|
44
|
-
export declare class EditingRenderMiddleware {
|
|
45
|
+
export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
|
|
45
46
|
private editingDataService;
|
|
46
47
|
private dataFetcher;
|
|
47
48
|
private resolvePageUrl;
|
|
@@ -55,16 +56,6 @@ export declare class EditingRenderMiddleware {
|
|
|
55
56
|
* @returns route handler
|
|
56
57
|
*/
|
|
57
58
|
getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
|
|
58
|
-
/**
|
|
59
|
-
* Gets query parameters that should be passed along to subsequent requests
|
|
60
|
-
* @param query Object of query parameters from incoming URL
|
|
61
|
-
* @returns Object of approved query parameters
|
|
62
|
-
*/
|
|
63
|
-
protected getQueryParamsForPropagation: (query: Partial<{
|
|
64
|
-
[key: string]: string | string[];
|
|
65
|
-
}>) => {
|
|
66
|
-
[key: string]: string;
|
|
67
|
-
};
|
|
68
59
|
private handler;
|
|
69
60
|
/**
|
|
70
61
|
* Default page URL resolution.
|