@sitecore-jss/sitecore-jss-nextjs 21.6.0-canary.9 → 21.7.0-canary.10
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/context.d.ts +1 -0
- package/context.js +1 -0
- package/dist/cjs/context/context.js +63 -0
- package/dist/cjs/context/index.js +5 -0
- package/dist/cjs/graphql/index.js +6 -0
- package/dist/cjs/index.js +10 -5
- package/dist/cjs/middleware/middleware.js +17 -0
- package/dist/cjs/middleware/multisite-middleware.js +1 -6
- package/dist/cjs/middleware/personalize-middleware.js +33 -46
- package/dist/cjs/middleware/redirects-middleware.js +13 -8
- package/dist/cjs/services/base-graphql-sitemap-service.js +8 -0
- package/dist/esm/context/context.js +59 -0
- package/dist/esm/context/index.js +1 -0
- package/dist/esm/graphql/index.js +1 -0
- package/dist/esm/index.js +8 -2
- package/dist/esm/middleware/middleware.js +17 -0
- package/dist/esm/middleware/multisite-middleware.js +1 -6
- package/dist/esm/middleware/personalize-middleware.js +34 -47
- package/dist/esm/middleware/redirects-middleware.js +13 -8
- package/dist/esm/services/base-graphql-sitemap-service.js +9 -1
- package/graphql.d.ts +1 -0
- package/graphql.js +1 -0
- package/package.json +9 -8
- package/types/context/context.d.ts +104 -0
- package/types/context/index.d.ts +1 -0
- package/types/graphql/index.d.ts +1 -0
- package/types/index.d.ts +6 -2
- package/types/middleware/middleware.d.ts +8 -0
- package/types/middleware/personalize-middleware.d.ts +20 -15
- package/types/services/base-graphql-sitemap-service.d.ts +10 -3
package/context.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './types/context/index';
|
package/context.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require('./dist/cjs/context/index');
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Context = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
|
|
6
|
+
*/
|
|
7
|
+
class Context {
|
|
8
|
+
constructor(props) {
|
|
9
|
+
this.props = props;
|
|
10
|
+
/**
|
|
11
|
+
* Indicates whether the Context and SDK(s) have been initialized
|
|
12
|
+
*/
|
|
13
|
+
this.isInitialized = false;
|
|
14
|
+
/**
|
|
15
|
+
* Software Development Kits (SDKs) to be initialized
|
|
16
|
+
*/
|
|
17
|
+
this.sdks = {};
|
|
18
|
+
/**
|
|
19
|
+
* Promises for the SDKs
|
|
20
|
+
*/
|
|
21
|
+
this.sdkPromises = {};
|
|
22
|
+
this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
|
|
23
|
+
this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
|
|
24
|
+
this.siteName = props.siteName;
|
|
25
|
+
}
|
|
26
|
+
init(props = {}) {
|
|
27
|
+
// Context and SDKs are initialized only once
|
|
28
|
+
if (this.isInitialized)
|
|
29
|
+
return;
|
|
30
|
+
this.isInitialized = true;
|
|
31
|
+
if (props.siteName) {
|
|
32
|
+
this.siteName = props.siteName;
|
|
33
|
+
}
|
|
34
|
+
// iterate over the SDKs and initialize them
|
|
35
|
+
for (const sdkName of Object.keys(this.props.sdks)) {
|
|
36
|
+
this.initSDK(sdkName);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
|
|
41
|
+
*
|
|
42
|
+
* @param {string} name SDK name
|
|
43
|
+
* @returns initialized SDK
|
|
44
|
+
*/
|
|
45
|
+
getSDK(name) {
|
|
46
|
+
return this.sdkPromises[name];
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Initializes the Software Development Kit (SDK)
|
|
50
|
+
*
|
|
51
|
+
* @param {T} name SDK name
|
|
52
|
+
* @returns {void}
|
|
53
|
+
*/
|
|
54
|
+
initSDK(name) {
|
|
55
|
+
this.sdkPromises[name] = new Promise((resolve) => {
|
|
56
|
+
this.props.sdks[name].init(this).then(() => {
|
|
57
|
+
this.sdks[name] = this.props.sdks[name].sdk;
|
|
58
|
+
resolve(this.sdks[name]);
|
|
59
|
+
});
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
exports.Context = Context;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getEdgeProxyContentUrl = exports.GraphQLRequestClient = void 0;
|
|
4
|
+
var graphql_1 = require("@sitecore-jss/sitecore-jss/graphql");
|
|
5
|
+
Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_1.GraphQLRequestClient; } });
|
|
6
|
+
Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return graphql_1.getEdgeProxyContentUrl; } });
|
package/dist/cjs/index.js
CHANGED
|
@@ -23,8 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
23
23
|
return result;
|
|
24
24
|
};
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
-
exports.NextImage = exports.EditingComponentPlaceholder = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.
|
|
27
|
-
exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.
|
|
26
|
+
exports.FEaaSWrapper = exports.NextImage = exports.EditingComponentPlaceholder = exports.Placeholder = exports.RichText = exports.Link = exports.useComponentProps = exports.ComponentPropsContext = exports.ComponentPropsReactContext = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSiteInfoService = exports.SiteResolver = exports.GraphQLRobotsService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.MultisiteGraphQLSitemapService = exports.GraphQLSitemapService = exports.DisconnectedSitemapService = exports.ComponentPropsService = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.tryParseEnvValue = exports.resolveUrl = exports.resetEditorChromes = exports.isEditorActive = exports.getPublicUrl = exports.handleEditorFastRefresh = exports.GraphQLRequestClient = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.AxiosDataFetcher = exports.constants = void 0;
|
|
27
|
+
exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.Context = exports.ComponentBuilder = exports.BYOCWrapper = void 0;
|
|
28
28
|
var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
29
29
|
Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
|
|
30
30
|
Object.defineProperty(exports, "AxiosDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.AxiosDataFetcher; } });
|
|
@@ -33,6 +33,7 @@ Object.defineProperty(exports, "enableDebug", { enumerable: true, get: function
|
|
|
33
33
|
Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
|
|
34
34
|
// we will remove the root exports for these later
|
|
35
35
|
// we cannot mark exports as deprected directly, so we're using this hack instead
|
|
36
|
+
const graphql_1 = require("./graphql");
|
|
36
37
|
const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
|
|
37
38
|
const utils_2 = require("./utils");
|
|
38
39
|
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
|
|
@@ -50,6 +51,11 @@ exports.resolveUrl = resolveUrl;
|
|
|
50
51
|
exports.tryParseEnvValue = tryParseEnvValue;
|
|
51
52
|
exports.handleEditorFastRefresh = handleEditorFastRefresh;
|
|
52
53
|
exports.getPublicUrl = getPublicUrl;
|
|
54
|
+
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
|
|
55
|
+
const { GraphQLRequestClientDep: GraphQLRequestClient } = {
|
|
56
|
+
GraphQLRequestClientDep: graphql_1.GraphQLRequestClient,
|
|
57
|
+
};
|
|
58
|
+
exports.GraphQLRequestClient = GraphQLRequestClient;
|
|
53
59
|
var layout_1 = require("@sitecore-jss/sitecore-jss/layout");
|
|
54
60
|
Object.defineProperty(exports, "LayoutServicePageState", { enumerable: true, get: function () { return layout_1.LayoutServicePageState; } });
|
|
55
61
|
Object.defineProperty(exports, "GraphQLLayoutService", { enumerable: true, get: function () { return layout_1.GraphQLLayoutService; } });
|
|
@@ -72,9 +78,6 @@ Object.defineProperty(exports, "getPersonalizedRewrite", { enumerable: true, get
|
|
|
72
78
|
Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true, get: function () { return personalize_1.getPersonalizedRewriteData; } });
|
|
73
79
|
Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return personalize_1.normalizePersonalizedRewrite; } });
|
|
74
80
|
Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return personalize_1.CdpHelper; } });
|
|
75
|
-
Object.defineProperty(exports, "PosResolver", { enumerable: true, get: function () { return personalize_1.PosResolver; } });
|
|
76
|
-
var sitecore_jss_2 = require("@sitecore-jss/sitecore-jss");
|
|
77
|
-
Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return sitecore_jss_2.GraphQLRequestClient; } });
|
|
78
81
|
var component_props_service_1 = require("./services/component-props-service");
|
|
79
82
|
Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
|
|
80
83
|
var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
|
|
@@ -112,6 +115,8 @@ const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
|
|
|
112
115
|
exports.BYOCWrapper = BYOCWrapper;
|
|
113
116
|
var ComponentBuilder_1 = require("./ComponentBuilder");
|
|
114
117
|
Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
|
|
118
|
+
var context_1 = require("./context");
|
|
119
|
+
Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
|
|
115
120
|
var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
|
|
116
121
|
Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return sitecore_jss_react_1.Image; } });
|
|
117
122
|
Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return sitecore_jss_react_1.Text; } });
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.MiddlewareBase = void 0;
|
|
4
|
+
const server_1 = require("next/server");
|
|
4
5
|
class MiddlewareBase {
|
|
5
6
|
constructor(config) {
|
|
6
7
|
this.config = config;
|
|
7
8
|
this.SITE_SYMBOL = 'sc_site';
|
|
9
|
+
this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
|
|
8
10
|
this.defaultHostname = config.defaultHostname || 'localhost';
|
|
9
11
|
}
|
|
10
12
|
/**
|
|
@@ -65,5 +67,20 @@ class MiddlewareBase {
|
|
|
65
67
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
66
68
|
return this.config.siteResolver.getByHost(hostname);
|
|
67
69
|
}
|
|
70
|
+
/**
|
|
71
|
+
* Create a rewrite response
|
|
72
|
+
* @param {string} rewritePath the destionation path
|
|
73
|
+
* @param {NextRequest} req the current request
|
|
74
|
+
* @param {NextResponse} res the current response
|
|
75
|
+
*/
|
|
76
|
+
rewrite(rewritePath, req, res) {
|
|
77
|
+
// Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
|
|
78
|
+
const rewriteUrl = req.nextUrl.clone();
|
|
79
|
+
rewriteUrl.pathname = rewritePath;
|
|
80
|
+
const response = server_1.NextResponse.rewrite(rewriteUrl, res);
|
|
81
|
+
// Share rewrite path with following executed middlewares
|
|
82
|
+
response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
|
|
83
|
+
return response;
|
|
84
|
+
}
|
|
68
85
|
}
|
|
69
86
|
exports.MiddlewareBase = MiddlewareBase;
|
|
@@ -51,14 +51,9 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
|
|
|
51
51
|
const rewritePath = (0, site_1.getSiteRewrite)(pathname, {
|
|
52
52
|
siteName,
|
|
53
53
|
});
|
|
54
|
-
|
|
55
|
-
const rewriteUrl = req.nextUrl.clone();
|
|
56
|
-
rewriteUrl.pathname = rewritePath;
|
|
57
|
-
response = server_1.NextResponse.rewrite(rewriteUrl);
|
|
54
|
+
response = this.rewrite(rewritePath, req, response);
|
|
58
55
|
// Share site name with the following executed middlewares
|
|
59
56
|
response.cookies.set(this.SITE_SYMBOL, siteName);
|
|
60
|
-
// Share rewrite path with following executed middlewares
|
|
61
|
-
response.headers.set('x-sc-rewrite', rewritePath);
|
|
62
57
|
sitecore_jss_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
63
58
|
rewritePath,
|
|
64
59
|
siteName,
|
|
@@ -14,7 +14,7 @@ const server_1 = require("next/server");
|
|
|
14
14
|
const personalize_1 = require("@sitecore-jss/sitecore-jss/personalize");
|
|
15
15
|
const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
|
|
16
16
|
const middleware_1 = require("./middleware");
|
|
17
|
-
const
|
|
17
|
+
const server_2 = require("@sitecore-cloudsdk/personalize/server");
|
|
18
18
|
/**
|
|
19
19
|
* Middleware / handler to support Sitecore Personalize
|
|
20
20
|
*/
|
|
@@ -26,7 +26,6 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
26
26
|
super(config);
|
|
27
27
|
this.config = config;
|
|
28
28
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
29
|
-
var _a;
|
|
30
29
|
const pathname = req.nextUrl.pathname;
|
|
31
30
|
const language = this.getLanguage(req);
|
|
32
31
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
@@ -62,30 +61,20 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
62
61
|
sitecore_jss_1.debug.personalize('skipped (no personalization configured)');
|
|
63
62
|
return response;
|
|
64
63
|
}
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
}
|
|
71
|
-
catch (error) {
|
|
72
|
-
sitecore_jss_1.debug.personalize('skipped (browser id generation failed)');
|
|
73
|
-
throw error;
|
|
74
|
-
}
|
|
64
|
+
yield this.initPersonalizeServer({
|
|
65
|
+
hostname,
|
|
66
|
+
siteName: site.name,
|
|
67
|
+
request: req,
|
|
68
|
+
response,
|
|
69
|
+
});
|
|
75
70
|
const params = this.getExperienceParams(req);
|
|
76
71
|
sitecore_jss_1.debug.personalize('executing experience for %s %s %o', personalizeInfo.contentId, params);
|
|
77
|
-
const personalizationData = {
|
|
78
|
-
channel: this.config.cdpConfig.channel || 'WEB',
|
|
79
|
-
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USA',
|
|
80
|
-
friendlyId: personalizeInfo.contentId,
|
|
81
|
-
params,
|
|
82
|
-
language,
|
|
83
|
-
};
|
|
84
72
|
let variantId;
|
|
85
|
-
// Execute targeted experience in
|
|
73
|
+
// Execute targeted experience in Personalize SDK
|
|
86
74
|
// eslint-disable-next-line no-useless-catch
|
|
87
75
|
try {
|
|
88
|
-
|
|
76
|
+
const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
|
|
77
|
+
variantId = personalization.variantId;
|
|
89
78
|
}
|
|
90
79
|
catch (error) {
|
|
91
80
|
throw error;
|
|
@@ -102,24 +91,10 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
102
91
|
const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
|
|
103
92
|
// Rewrite to persononalized path
|
|
104
93
|
const rewritePath = (0, personalize_1.getPersonalizedRewrite)(basePath, { variantId });
|
|
105
|
-
|
|
106
|
-
const rewriteUrl = req.nextUrl.clone();
|
|
107
|
-
// Preserve cookies from previous response
|
|
108
|
-
const cookies = response.cookies.getAll();
|
|
109
|
-
rewriteUrl.pathname = rewritePath;
|
|
110
|
-
response = server_1.NextResponse.rewrite(rewriteUrl, response);
|
|
94
|
+
response = this.rewrite(rewritePath, req, response);
|
|
111
95
|
// Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
|
|
112
96
|
// See https://github.com/vercel/next.js/issues/32727
|
|
113
97
|
response.headers.set('x-middleware-cache', 'no-cache');
|
|
114
|
-
// Share rewrite path with following executed middleware
|
|
115
|
-
response.headers.set('x-sc-rewrite', rewritePath);
|
|
116
|
-
// Share site name with the following executed middlewares
|
|
117
|
-
response.cookies.set(this.SITE_SYMBOL, site.name);
|
|
118
|
-
// Restore cookies from previous response since
|
|
119
|
-
// browserId cookie gets omitted after rewrite
|
|
120
|
-
cookies.forEach((cookie) => {
|
|
121
|
-
response.cookies.set(cookie);
|
|
122
|
-
});
|
|
123
98
|
sitecore_jss_1.debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
124
99
|
rewritePath,
|
|
125
100
|
headers: this.extractDebugHeaders(response.headers),
|
|
@@ -146,17 +121,29 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
|
|
|
146
121
|
}
|
|
147
122
|
});
|
|
148
123
|
}
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
:
|
|
156
|
-
|
|
157
|
-
|
|
124
|
+
initPersonalizeServer({ hostname, siteName, request, response, }) {
|
|
125
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
126
|
+
yield (0, server_2.init)({
|
|
127
|
+
sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
|
|
128
|
+
sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
|
|
129
|
+
siteName,
|
|
130
|
+
cookieDomain: hostname,
|
|
131
|
+
enableServerCookie: true,
|
|
132
|
+
}, request, response);
|
|
133
|
+
});
|
|
134
|
+
}
|
|
135
|
+
personalize({ params, personalizeInfo, language, timeout, }, request) {
|
|
136
|
+
var _a;
|
|
137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
const personalizationData = {
|
|
139
|
+
channel: this.config.cdpConfig.channel || 'WEB',
|
|
140
|
+
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
|
|
141
|
+
friendlyId: personalizeInfo.contentId,
|
|
142
|
+
params,
|
|
143
|
+
language,
|
|
144
|
+
};
|
|
145
|
+
return (yield (0, server_2.personalize)(personalizationData, request, timeout));
|
|
158
146
|
});
|
|
159
|
-
return engageServer;
|
|
160
147
|
}
|
|
161
148
|
getExperienceParams(req) {
|
|
162
149
|
const utm = {
|
|
@@ -42,7 +42,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
|
|
|
42
42
|
hostname,
|
|
43
43
|
});
|
|
44
44
|
const createResponse = () => __awaiter(this, void 0, void 0, function* () {
|
|
45
|
-
if (this.config.disabled && this.config.disabled(req, server_1.NextResponse.next())) {
|
|
45
|
+
if (this.config.disabled && this.config.disabled(req, res || server_1.NextResponse.next())) {
|
|
46
46
|
sitecore_jss_1.debug.redirects('skipped (redirects middleware is disabled)');
|
|
47
47
|
return res || server_1.NextResponse.next();
|
|
48
48
|
}
|
|
@@ -82,19 +82,24 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
|
|
|
82
82
|
/** return Response redirect with http code of redirect type **/
|
|
83
83
|
switch (existsRedirect.redirectType) {
|
|
84
84
|
case site_1.REDIRECT_TYPE_301:
|
|
85
|
-
return server_1.NextResponse.redirect(redirectUrl,
|
|
85
|
+
return server_1.NextResponse.redirect(redirectUrl, {
|
|
86
|
+
status: 301,
|
|
87
|
+
statusText: 'Moved Permanently',
|
|
88
|
+
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
89
|
+
});
|
|
86
90
|
case site_1.REDIRECT_TYPE_302:
|
|
87
|
-
return server_1.NextResponse.redirect(redirectUrl,
|
|
91
|
+
return server_1.NextResponse.redirect(redirectUrl, {
|
|
92
|
+
status: 302,
|
|
93
|
+
statusText: 'Found',
|
|
94
|
+
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
95
|
+
});
|
|
88
96
|
case site_1.REDIRECT_TYPE_SERVER_TRANSFER:
|
|
89
|
-
return server_1.NextResponse.rewrite(redirectUrl);
|
|
97
|
+
return server_1.NextResponse.rewrite(redirectUrl, res);
|
|
90
98
|
default:
|
|
91
|
-
return server_1.NextResponse.next();
|
|
99
|
+
return res || server_1.NextResponse.next();
|
|
92
100
|
}
|
|
93
101
|
});
|
|
94
102
|
const response = yield createResponse();
|
|
95
|
-
// Share site name with the following executed middlewares
|
|
96
|
-
// Don't need to set when middleware is disabled
|
|
97
|
-
site && response.cookies.set(this.SITE_SYMBOL, site.name);
|
|
98
103
|
sitecore_jss_1.debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
99
104
|
redirected: response.redirected,
|
|
100
105
|
status: response.status,
|
|
@@ -195,6 +195,14 @@ class BaseGraphQLSitemapService {
|
|
|
195
195
|
* @returns {GraphQLClient} implementation
|
|
196
196
|
*/
|
|
197
197
|
getGraphQLClient() {
|
|
198
|
+
if (!this.options.endpoint) {
|
|
199
|
+
if (!this.options.clientFactory) {
|
|
200
|
+
throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
|
|
201
|
+
}
|
|
202
|
+
return this.options.clientFactory({
|
|
203
|
+
debugger: sitecore_jss_1.debug.sitemap,
|
|
204
|
+
});
|
|
205
|
+
}
|
|
198
206
|
return new graphql_1.GraphQLRequestClient(this.options.endpoint, {
|
|
199
207
|
apiKey: this.options.apiKey,
|
|
200
208
|
debugger: sitecore_jss_1.debug.sitemap,
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
|
|
3
|
+
*/
|
|
4
|
+
export class Context {
|
|
5
|
+
constructor(props) {
|
|
6
|
+
this.props = props;
|
|
7
|
+
/**
|
|
8
|
+
* Indicates whether the Context and SDK(s) have been initialized
|
|
9
|
+
*/
|
|
10
|
+
this.isInitialized = false;
|
|
11
|
+
/**
|
|
12
|
+
* Software Development Kits (SDKs) to be initialized
|
|
13
|
+
*/
|
|
14
|
+
this.sdks = {};
|
|
15
|
+
/**
|
|
16
|
+
* Promises for the SDKs
|
|
17
|
+
*/
|
|
18
|
+
this.sdkPromises = {};
|
|
19
|
+
this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
|
|
20
|
+
this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
|
|
21
|
+
this.siteName = props.siteName;
|
|
22
|
+
}
|
|
23
|
+
init(props = {}) {
|
|
24
|
+
// Context and SDKs are initialized only once
|
|
25
|
+
if (this.isInitialized)
|
|
26
|
+
return;
|
|
27
|
+
this.isInitialized = true;
|
|
28
|
+
if (props.siteName) {
|
|
29
|
+
this.siteName = props.siteName;
|
|
30
|
+
}
|
|
31
|
+
// iterate over the SDKs and initialize them
|
|
32
|
+
for (const sdkName of Object.keys(this.props.sdks)) {
|
|
33
|
+
this.initSDK(sdkName);
|
|
34
|
+
}
|
|
35
|
+
}
|
|
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
|
+
/**
|
|
46
|
+
* Initializes the Software Development Kit (SDK)
|
|
47
|
+
*
|
|
48
|
+
* @param {T} name SDK name
|
|
49
|
+
* @returns {void}
|
|
50
|
+
*/
|
|
51
|
+
initSDK(name) {
|
|
52
|
+
this.sdkPromises[name] = new Promise((resolve) => {
|
|
53
|
+
this.props.sdks[name].init(this).then(() => {
|
|
54
|
+
this.sdks[name] = this.props.sdks[name].sdk;
|
|
55
|
+
resolve(this.sdks[name]);
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { Context } from './context';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
|
package/dist/esm/index.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
|
|
2
2
|
// we will remove the root exports for these later
|
|
3
3
|
// we cannot mark exports as deprected directly, so we're using this hack instead
|
|
4
|
+
import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
|
|
4
5
|
import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
|
|
5
6
|
import { handleEditorFastRefresh as handleEditorFastRefreshDep, getPublicUrl as getPublicUrlDep, } from './utils';
|
|
6
7
|
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
|
|
@@ -12,14 +13,18 @@ const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChr
|
|
|
12
13
|
handleEditorFastRefreshDep,
|
|
13
14
|
getPublicUrlDep,
|
|
14
15
|
};
|
|
16
|
+
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
|
|
17
|
+
const { GraphQLRequestClientDep: GraphQLRequestClient } = {
|
|
18
|
+
GraphQLRequestClientDep,
|
|
19
|
+
};
|
|
20
|
+
export { GraphQLRequestClient };
|
|
15
21
|
export { handleEditorFastRefresh, getPublicUrl };
|
|
16
22
|
export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
|
|
17
23
|
export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
|
|
18
24
|
export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
|
|
19
25
|
export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
|
|
20
26
|
export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
|
|
21
|
-
export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper,
|
|
22
|
-
export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
|
|
27
|
+
export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
|
|
23
28
|
export { ComponentPropsService } from './services/component-props-service';
|
|
24
29
|
export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
|
|
25
30
|
export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
|
|
@@ -36,4 +41,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
|
|
|
36
41
|
export { FEaaSWrapper };
|
|
37
42
|
export { BYOCWrapper };
|
|
38
43
|
export { ComponentBuilder } from './ComponentBuilder';
|
|
44
|
+
export { Context } from './context';
|
|
39
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';
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
+
import { NextResponse } from 'next/server';
|
|
1
2
|
export class MiddlewareBase {
|
|
2
3
|
constructor(config) {
|
|
3
4
|
this.config = config;
|
|
4
5
|
this.SITE_SYMBOL = 'sc_site';
|
|
6
|
+
this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
|
|
5
7
|
this.defaultHostname = config.defaultHostname || 'localhost';
|
|
6
8
|
}
|
|
7
9
|
/**
|
|
@@ -62,4 +64,19 @@ export class MiddlewareBase {
|
|
|
62
64
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
63
65
|
return this.config.siteResolver.getByHost(hostname);
|
|
64
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
* Create a rewrite response
|
|
69
|
+
* @param {string} rewritePath the destionation path
|
|
70
|
+
* @param {NextRequest} req the current request
|
|
71
|
+
* @param {NextResponse} res the current response
|
|
72
|
+
*/
|
|
73
|
+
rewrite(rewritePath, req, res) {
|
|
74
|
+
// Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
|
|
75
|
+
const rewriteUrl = req.nextUrl.clone();
|
|
76
|
+
rewriteUrl.pathname = rewritePath;
|
|
77
|
+
const response = NextResponse.rewrite(rewriteUrl, res);
|
|
78
|
+
// Share rewrite path with following executed middlewares
|
|
79
|
+
response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
|
|
80
|
+
return response;
|
|
81
|
+
}
|
|
65
82
|
}
|
|
@@ -48,14 +48,9 @@ export class MultisiteMiddleware extends MiddlewareBase {
|
|
|
48
48
|
const rewritePath = getSiteRewrite(pathname, {
|
|
49
49
|
siteName,
|
|
50
50
|
});
|
|
51
|
-
|
|
52
|
-
const rewriteUrl = req.nextUrl.clone();
|
|
53
|
-
rewriteUrl.pathname = rewritePath;
|
|
54
|
-
response = NextResponse.rewrite(rewriteUrl);
|
|
51
|
+
response = this.rewrite(rewritePath, req, response);
|
|
55
52
|
// Share site name with the following executed middlewares
|
|
56
53
|
response.cookies.set(this.SITE_SYMBOL, siteName);
|
|
57
|
-
// Share rewrite path with following executed middlewares
|
|
58
|
-
response.headers.set('x-sc-rewrite', rewritePath);
|
|
59
54
|
debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
60
55
|
rewritePath,
|
|
61
56
|
siteName,
|
|
@@ -8,10 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
8
8
|
});
|
|
9
9
|
};
|
|
10
10
|
import { NextResponse } from 'next/server';
|
|
11
|
-
import { GraphQLPersonalizeService, getPersonalizedRewrite,
|
|
11
|
+
import { GraphQLPersonalizeService, getPersonalizedRewrite, } 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 { init, personalize } from '@sitecore-cloudsdk/personalize/server';
|
|
15
15
|
/**
|
|
16
16
|
* Middleware / handler to support Sitecore Personalize
|
|
17
17
|
*/
|
|
@@ -23,7 +23,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
23
23
|
super(config);
|
|
24
24
|
this.config = config;
|
|
25
25
|
this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
|
|
26
|
-
var _a;
|
|
27
26
|
const pathname = req.nextUrl.pathname;
|
|
28
27
|
const language = this.getLanguage(req);
|
|
29
28
|
const hostname = this.getHostHeader(req) || this.defaultHostname;
|
|
@@ -59,30 +58,20 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
59
58
|
debug.personalize('skipped (no personalization configured)');
|
|
60
59
|
return response;
|
|
61
60
|
}
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
}
|
|
68
|
-
catch (error) {
|
|
69
|
-
debug.personalize('skipped (browser id generation failed)');
|
|
70
|
-
throw error;
|
|
71
|
-
}
|
|
61
|
+
yield this.initPersonalizeServer({
|
|
62
|
+
hostname,
|
|
63
|
+
siteName: site.name,
|
|
64
|
+
request: req,
|
|
65
|
+
response,
|
|
66
|
+
});
|
|
72
67
|
const params = this.getExperienceParams(req);
|
|
73
68
|
debug.personalize('executing experience for %s %s %o', personalizeInfo.contentId, params);
|
|
74
|
-
const personalizationData = {
|
|
75
|
-
channel: this.config.cdpConfig.channel || 'WEB',
|
|
76
|
-
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USA',
|
|
77
|
-
friendlyId: personalizeInfo.contentId,
|
|
78
|
-
params,
|
|
79
|
-
language,
|
|
80
|
-
};
|
|
81
69
|
let variantId;
|
|
82
|
-
// Execute targeted experience in
|
|
70
|
+
// Execute targeted experience in Personalize SDK
|
|
83
71
|
// eslint-disable-next-line no-useless-catch
|
|
84
72
|
try {
|
|
85
|
-
|
|
73
|
+
const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
|
|
74
|
+
variantId = personalization.variantId;
|
|
86
75
|
}
|
|
87
76
|
catch (error) {
|
|
88
77
|
throw error;
|
|
@@ -99,24 +88,10 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
99
88
|
const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
|
|
100
89
|
// Rewrite to persononalized path
|
|
101
90
|
const rewritePath = getPersonalizedRewrite(basePath, { variantId });
|
|
102
|
-
|
|
103
|
-
const rewriteUrl = req.nextUrl.clone();
|
|
104
|
-
// Preserve cookies from previous response
|
|
105
|
-
const cookies = response.cookies.getAll();
|
|
106
|
-
rewriteUrl.pathname = rewritePath;
|
|
107
|
-
response = NextResponse.rewrite(rewriteUrl, response);
|
|
91
|
+
response = this.rewrite(rewritePath, req, response);
|
|
108
92
|
// Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
|
|
109
93
|
// See https://github.com/vercel/next.js/issues/32727
|
|
110
94
|
response.headers.set('x-middleware-cache', 'no-cache');
|
|
111
|
-
// Share rewrite path with following executed middleware
|
|
112
|
-
response.headers.set('x-sc-rewrite', rewritePath);
|
|
113
|
-
// Share site name with the following executed middlewares
|
|
114
|
-
response.cookies.set(this.SITE_SYMBOL, site.name);
|
|
115
|
-
// Restore cookies from previous response since
|
|
116
|
-
// browserId cookie gets omitted after rewrite
|
|
117
|
-
cookies.forEach((cookie) => {
|
|
118
|
-
response.cookies.set(cookie);
|
|
119
|
-
});
|
|
120
95
|
debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
121
96
|
rewritePath,
|
|
122
97
|
headers: this.extractDebugHeaders(response.headers),
|
|
@@ -143,17 +118,29 @@ export class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
143
118
|
}
|
|
144
119
|
});
|
|
145
120
|
}
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
:
|
|
153
|
-
|
|
154
|
-
|
|
121
|
+
initPersonalizeServer({ hostname, siteName, request, response, }) {
|
|
122
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
123
|
+
yield init({
|
|
124
|
+
sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
|
|
125
|
+
sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
|
|
126
|
+
siteName,
|
|
127
|
+
cookieDomain: hostname,
|
|
128
|
+
enableServerCookie: true,
|
|
129
|
+
}, request, response);
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
personalize({ params, personalizeInfo, language, timeout, }, request) {
|
|
133
|
+
var _a;
|
|
134
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
135
|
+
const personalizationData = {
|
|
136
|
+
channel: this.config.cdpConfig.channel || 'WEB',
|
|
137
|
+
currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
|
|
138
|
+
friendlyId: personalizeInfo.contentId,
|
|
139
|
+
params,
|
|
140
|
+
language,
|
|
141
|
+
};
|
|
142
|
+
return (yield personalize(personalizationData, request, timeout));
|
|
155
143
|
});
|
|
156
|
-
return engageServer;
|
|
157
144
|
}
|
|
158
145
|
getExperienceParams(req) {
|
|
159
146
|
const utm = {
|
|
@@ -36,7 +36,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
|
|
|
36
36
|
hostname,
|
|
37
37
|
});
|
|
38
38
|
const createResponse = () => __awaiter(this, void 0, void 0, function* () {
|
|
39
|
-
if (this.config.disabled && this.config.disabled(req, NextResponse.next())) {
|
|
39
|
+
if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
|
|
40
40
|
debug.redirects('skipped (redirects middleware is disabled)');
|
|
41
41
|
return res || NextResponse.next();
|
|
42
42
|
}
|
|
@@ -76,19 +76,24 @@ export class RedirectsMiddleware extends MiddlewareBase {
|
|
|
76
76
|
/** return Response redirect with http code of redirect type **/
|
|
77
77
|
switch (existsRedirect.redirectType) {
|
|
78
78
|
case REDIRECT_TYPE_301:
|
|
79
|
-
return NextResponse.redirect(redirectUrl,
|
|
79
|
+
return NextResponse.redirect(redirectUrl, {
|
|
80
|
+
status: 301,
|
|
81
|
+
statusText: 'Moved Permanently',
|
|
82
|
+
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
83
|
+
});
|
|
80
84
|
case REDIRECT_TYPE_302:
|
|
81
|
-
return NextResponse.redirect(redirectUrl,
|
|
85
|
+
return NextResponse.redirect(redirectUrl, {
|
|
86
|
+
status: 302,
|
|
87
|
+
statusText: 'Found',
|
|
88
|
+
headers: res === null || res === void 0 ? void 0 : res.headers,
|
|
89
|
+
});
|
|
82
90
|
case REDIRECT_TYPE_SERVER_TRANSFER:
|
|
83
|
-
return NextResponse.rewrite(redirectUrl);
|
|
91
|
+
return NextResponse.rewrite(redirectUrl, res);
|
|
84
92
|
default:
|
|
85
|
-
return NextResponse.next();
|
|
93
|
+
return res || NextResponse.next();
|
|
86
94
|
}
|
|
87
95
|
});
|
|
88
96
|
const response = yield createResponse();
|
|
89
|
-
// Share site name with the following executed middlewares
|
|
90
|
-
// Don't need to set when middleware is disabled
|
|
91
|
-
site && response.cookies.set(this.SITE_SYMBOL, site.name);
|
|
92
97
|
debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
|
|
93
98
|
redirected: response.redirected,
|
|
94
99
|
status: response.status,
|
|
@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
7
7
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
8
|
});
|
|
9
9
|
};
|
|
10
|
-
import { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss/graphql';
|
|
10
|
+
import { GraphQLRequestClient, } from '@sitecore-jss/sitecore-jss/graphql';
|
|
11
11
|
import { debug } from '@sitecore-jss/sitecore-jss';
|
|
12
12
|
import { getPersonalizedRewrite } from '@sitecore-jss/sitecore-jss/personalize';
|
|
13
13
|
/** @private */
|
|
@@ -191,6 +191,14 @@ export class BaseGraphQLSitemapService {
|
|
|
191
191
|
* @returns {GraphQLClient} implementation
|
|
192
192
|
*/
|
|
193
193
|
getGraphQLClient() {
|
|
194
|
+
if (!this.options.endpoint) {
|
|
195
|
+
if (!this.options.clientFactory) {
|
|
196
|
+
throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
|
|
197
|
+
}
|
|
198
|
+
return this.options.clientFactory({
|
|
199
|
+
debugger: debug.sitemap,
|
|
200
|
+
});
|
|
201
|
+
}
|
|
194
202
|
return new GraphQLRequestClient(this.options.endpoint, {
|
|
195
203
|
apiKey: this.options.apiKey,
|
|
196
204
|
debugger: debug.sitemap,
|
package/graphql.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './types/graphql/index';
|
package/graphql.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require('./dist/cjs/graphql/index');
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sitecore-jss/sitecore-jss-nextjs",
|
|
3
|
-
"version": "21.
|
|
3
|
+
"version": "21.7.0-canary.10",
|
|
4
4
|
"main": "dist/cjs/index.js",
|
|
5
5
|
"module": "dist/esm/index.js",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"test": "mocha --require ./test/setup.js \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
|
|
12
12
|
"prepublishOnly": "npm run build",
|
|
13
13
|
"coverage": "nyc npm test",
|
|
14
|
-
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --githubPages false"
|
|
14
|
+
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
|
|
15
15
|
},
|
|
16
16
|
"engines": {
|
|
17
17
|
"node": ">=12",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"url": "https://github.com/sitecore/jss/issues"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
|
-
"@sitecore/
|
|
33
|
+
"@sitecore-cloudsdk/personalize": "^0.1.1",
|
|
34
34
|
"@types/chai": "^4.3.4",
|
|
35
35
|
"@types/chai-as-promised": "^7.1.5",
|
|
36
36
|
"@types/chai-string": "^1.4.2",
|
|
@@ -66,15 +66,16 @@
|
|
|
66
66
|
"typescript": "~4.9.4"
|
|
67
67
|
},
|
|
68
68
|
"peerDependencies": {
|
|
69
|
-
"@sitecore/
|
|
69
|
+
"@sitecore-cloudsdk/events": "^0.1.1",
|
|
70
|
+
"@sitecore-cloudsdk/personalize": "^0.1.1",
|
|
70
71
|
"next": "^13.4.16",
|
|
71
72
|
"react": "^18.2.0",
|
|
72
73
|
"react-dom": "^18.2.0"
|
|
73
74
|
},
|
|
74
75
|
"dependencies": {
|
|
75
|
-
"@sitecore-jss/sitecore-jss": "^21.
|
|
76
|
-
"@sitecore-jss/sitecore-jss-dev-tools": "^21.
|
|
77
|
-
"@sitecore-jss/sitecore-jss-react": "^21.
|
|
76
|
+
"@sitecore-jss/sitecore-jss": "^21.7.0-canary.10",
|
|
77
|
+
"@sitecore-jss/sitecore-jss-dev-tools": "^21.7.0-canary.10",
|
|
78
|
+
"@sitecore-jss/sitecore-jss-react": "^21.7.0-canary.10",
|
|
78
79
|
"@vercel/kv": "^0.2.1",
|
|
79
80
|
"node-html-parser": "^6.1.4",
|
|
80
81
|
"prop-types": "^15.8.1",
|
|
@@ -83,7 +84,7 @@
|
|
|
83
84
|
},
|
|
84
85
|
"description": "",
|
|
85
86
|
"types": "types/index.d.ts",
|
|
86
|
-
"gitHead": "
|
|
87
|
+
"gitHead": "1385bba45f39eb4e27f62af1351b60b66a87dac8",
|
|
87
88
|
"files": [
|
|
88
89
|
"dist",
|
|
89
90
|
"types",
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Software Development Kit (SDK) instance
|
|
3
|
+
*/
|
|
4
|
+
export type SDK<SDKType = unknown> = {
|
|
5
|
+
/**
|
|
6
|
+
* The Software Development Kit (SDK) library instance
|
|
7
|
+
*/
|
|
8
|
+
sdk: SDKType;
|
|
9
|
+
/**
|
|
10
|
+
* Initializes the Software Development Kit (SDK)
|
|
11
|
+
*/
|
|
12
|
+
init: (props: InitSDKProps) => Promise<void>;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Software Development Kits (SDKs) to be initialized
|
|
16
|
+
*/
|
|
17
|
+
type SDKModulesType = Record<string, SDK>;
|
|
18
|
+
/**
|
|
19
|
+
* Properties that are passed to the Context.
|
|
20
|
+
*/
|
|
21
|
+
export interface ContextInitProps {
|
|
22
|
+
/**
|
|
23
|
+
* Your Sitecore site name
|
|
24
|
+
*/
|
|
25
|
+
siteName?: string;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Configuration that is passed to the Context.
|
|
29
|
+
*/
|
|
30
|
+
export interface ContextConfig<SDKModules extends SDKModulesType> {
|
|
31
|
+
/**
|
|
32
|
+
* Your Sitecore Edge URL
|
|
33
|
+
*/
|
|
34
|
+
sitecoreEdgeUrl: string;
|
|
35
|
+
/**
|
|
36
|
+
* Your Sitecore Edge Context ID
|
|
37
|
+
*/
|
|
38
|
+
sitecoreEdgeContextId: string;
|
|
39
|
+
/**
|
|
40
|
+
* Your Sitecore site name
|
|
41
|
+
*/
|
|
42
|
+
siteName: string;
|
|
43
|
+
/**
|
|
44
|
+
* Software Development Kits (SDKs) to be initialized
|
|
45
|
+
*/
|
|
46
|
+
sdks: {
|
|
47
|
+
[module in keyof SDKModules]: SDKModules[module];
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Properties that are passed to the Software Development Kit (SDK) initialization function.
|
|
52
|
+
*/
|
|
53
|
+
type InitSDKProps = Omit<ContextConfig<SDKModulesType>, 'sdks'>;
|
|
54
|
+
/**
|
|
55
|
+
* Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
|
|
56
|
+
*/
|
|
57
|
+
export declare class Context<SDKModules extends SDKModulesType> {
|
|
58
|
+
protected props: ContextConfig<SDKModules>;
|
|
59
|
+
/**
|
|
60
|
+
* Indicates whether the Context and SDK(s) have been initialized
|
|
61
|
+
*/
|
|
62
|
+
isInitialized: boolean;
|
|
63
|
+
/**
|
|
64
|
+
* The Sitecore Edge URL
|
|
65
|
+
*/
|
|
66
|
+
readonly sitecoreEdgeUrl: string;
|
|
67
|
+
/**
|
|
68
|
+
* The Sitecore Edge Context ID
|
|
69
|
+
*/
|
|
70
|
+
readonly sitecoreEdgeContextId: string;
|
|
71
|
+
/**
|
|
72
|
+
* The Sitecore site name
|
|
73
|
+
*/
|
|
74
|
+
siteName: string;
|
|
75
|
+
/**
|
|
76
|
+
* Software Development Kits (SDKs) to be initialized
|
|
77
|
+
*/
|
|
78
|
+
readonly sdks: {
|
|
79
|
+
[module in keyof SDKModules]?: SDKModules[module]['sdk'];
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* Promises for the SDKs
|
|
83
|
+
*/
|
|
84
|
+
protected sdkPromises: {
|
|
85
|
+
[module in keyof SDKModules]?: Promise<SDKModules[module]['sdk']>;
|
|
86
|
+
};
|
|
87
|
+
constructor(props: ContextConfig<SDKModules>);
|
|
88
|
+
init(props?: ContextInitProps): void;
|
|
89
|
+
/**
|
|
90
|
+
* Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
|
|
91
|
+
*
|
|
92
|
+
* @param {string} name SDK name
|
|
93
|
+
* @returns initialized SDK
|
|
94
|
+
*/
|
|
95
|
+
getSDK<T extends keyof SDKModules>(name: T): Promise<SDKModules[T]['sdk']> | undefined;
|
|
96
|
+
/**
|
|
97
|
+
* Initializes the Software Development Kit (SDK)
|
|
98
|
+
*
|
|
99
|
+
* @param {T} name SDK name
|
|
100
|
+
* @returns {void}
|
|
101
|
+
*/
|
|
102
|
+
protected initSDK<T extends keyof SDKModules>(name: T): void;
|
|
103
|
+
}
|
|
104
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { Context, ContextConfig, SDK } from './context';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { GraphQLRequestClient, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';
|
package/types/index.d.ts
CHANGED
|
@@ -1,15 +1,18 @@
|
|
|
1
1
|
export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
|
|
2
|
+
import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
|
|
2
3
|
import { resolveUrl as resolveUrlDep } from '@sitecore-jss/sitecore-jss/utils';
|
|
3
4
|
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
|
|
4
5
|
declare const isEditorActive: () => boolean, resetEditorChromes: () => void, resolveUrl: typeof resolveUrlDep, tryParseEnvValue: <T>(envValue: string | undefined, defaultValue: T) => T, handleEditorFastRefresh: (forceReload?: boolean) => void, getPublicUrl: () => string;
|
|
6
|
+
/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
|
|
7
|
+
declare const GraphQLRequestClient: typeof GraphQLRequestClientDep;
|
|
8
|
+
export { GraphQLRequestClient };
|
|
5
9
|
export { handleEditorFastRefresh, getPublicUrl };
|
|
6
10
|
export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
|
|
7
11
|
export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, RestLayoutService, RestLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
|
|
8
12
|
export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
|
|
9
13
|
export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
|
|
10
14
|
export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
|
|
11
|
-
export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper,
|
|
12
|
-
export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
|
|
15
|
+
export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
|
|
13
16
|
export { ComponentPropsCollection, ComponentPropsError, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
|
|
14
17
|
export { ModuleFactory, Module } from './sharedTypes/module-factory';
|
|
15
18
|
export { ComponentPropsService } from './services/component-props-service';
|
|
@@ -29,4 +32,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
|
|
|
29
32
|
export { FEaaSWrapper };
|
|
30
33
|
export { BYOCWrapper };
|
|
31
34
|
export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
|
|
35
|
+
export { Context, ContextConfig, SDK } from './context';
|
|
32
36
|
export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getFEAASLibraryStylesheetLinks, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';
|
|
@@ -28,6 +28,7 @@ export type MiddlewareBaseConfig = {
|
|
|
28
28
|
export declare abstract class MiddlewareBase {
|
|
29
29
|
protected config: MiddlewareBaseConfig;
|
|
30
30
|
protected SITE_SYMBOL: string;
|
|
31
|
+
protected REWRITE_HEADER_NAME: string;
|
|
31
32
|
protected defaultHostname: string;
|
|
32
33
|
constructor(config: MiddlewareBaseConfig);
|
|
33
34
|
/**
|
|
@@ -65,4 +66,11 @@ export declare abstract class MiddlewareBase {
|
|
|
65
66
|
* @returns {SiteInfo} site information
|
|
66
67
|
*/
|
|
67
68
|
protected getSite(req: NextRequest, res?: NextResponse): SiteInfo;
|
|
69
|
+
/**
|
|
70
|
+
* Create a rewrite response
|
|
71
|
+
* @param {string} rewritePath the destionation path
|
|
72
|
+
* @param {NextRequest} req the current request
|
|
73
|
+
* @param {NextResponse} res the current response
|
|
74
|
+
*/
|
|
75
|
+
protected rewrite(rewritePath: string, req: NextRequest, res: NextResponse): NextResponse;
|
|
68
76
|
}
|
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
import { NextResponse, NextRequest } from 'next/server';
|
|
2
|
-
import { GraphQLPersonalizeServiceConfig } from '@sitecore-jss/sitecore-jss/personalize';
|
|
3
|
-
import { SiteInfo } from '@sitecore-jss/sitecore-jss/site';
|
|
2
|
+
import { GraphQLPersonalizeServiceConfig, PersonalizeInfo } from '@sitecore-jss/sitecore-jss/personalize';
|
|
4
3
|
import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
|
|
5
|
-
import { EngageServer } from '@sitecore/engage';
|
|
6
4
|
export type CdpServiceConfig = {
|
|
7
5
|
/**
|
|
8
|
-
* Your Sitecore
|
|
6
|
+
* Your Sitecore Edge Platform endpoint
|
|
7
|
+
* Default is https://edge-platform.sitecorecloud.io
|
|
9
8
|
*/
|
|
10
|
-
|
|
9
|
+
sitecoreEdgeUrl?: string;
|
|
11
10
|
/**
|
|
12
|
-
*
|
|
11
|
+
* Your unified Sitecore Edge Context Id
|
|
13
12
|
*/
|
|
14
|
-
|
|
13
|
+
sitecoreEdgeContextId: string;
|
|
15
14
|
/**
|
|
16
15
|
* The Sitecore CDP channel to use for events. Uses 'WEB' by default.
|
|
17
16
|
*/
|
|
@@ -34,13 +33,6 @@ export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
|
|
|
34
33
|
* Configuration for your Sitecore CDP endpoint
|
|
35
34
|
*/
|
|
36
35
|
cdpConfig: CdpServiceConfig;
|
|
37
|
-
/**
|
|
38
|
-
* function to resolve point of sale for a site
|
|
39
|
-
* @param {Siteinfo} site to get info from
|
|
40
|
-
* @param {string} language to get info for
|
|
41
|
-
* @returns point of sale value for site/language combination
|
|
42
|
-
*/
|
|
43
|
-
getPointOfSale?: (site: SiteInfo, language: string) => string;
|
|
44
36
|
};
|
|
45
37
|
/**
|
|
46
38
|
* Object model of Experience Context data
|
|
@@ -70,7 +62,20 @@ export declare class PersonalizeMiddleware extends MiddlewareBase {
|
|
|
70
62
|
* @returns middleware handler
|
|
71
63
|
*/
|
|
72
64
|
getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
|
|
73
|
-
protected
|
|
65
|
+
protected initPersonalizeServer({ hostname, siteName, request, response, }: {
|
|
66
|
+
hostname: string;
|
|
67
|
+
siteName: string;
|
|
68
|
+
request: NextRequest;
|
|
69
|
+
response: NextResponse;
|
|
70
|
+
}): Promise<void>;
|
|
71
|
+
protected personalize({ params, personalizeInfo, language, timeout, }: {
|
|
72
|
+
personalizeInfo: PersonalizeInfo;
|
|
73
|
+
params: ExperienceParams;
|
|
74
|
+
language: string;
|
|
75
|
+
timeout?: number;
|
|
76
|
+
}, request: NextRequest): Promise<{
|
|
77
|
+
variantId: string;
|
|
78
|
+
}>;
|
|
74
79
|
protected getExperienceParams(req: NextRequest): ExperienceParams;
|
|
75
80
|
protected excludeRoute(pathname: string): boolean | undefined;
|
|
76
81
|
private handler;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { GraphQLClient, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
|
|
1
|
+
import { GraphQLClient, GraphQLRequestClientFactory, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
|
|
2
2
|
/** @private */
|
|
3
3
|
export declare const languageError = "The list of languages cannot be empty";
|
|
4
4
|
export declare const siteError = "The service needs a site name";
|
|
@@ -68,17 +68,24 @@ export type RouteListQueryResult = {
|
|
|
68
68
|
export interface BaseGraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariables, 'language' | 'siteName'> {
|
|
69
69
|
/**
|
|
70
70
|
* Your Graphql endpoint
|
|
71
|
+
* @deprecated use @param clientFactory property instead
|
|
71
72
|
*/
|
|
72
|
-
endpoint
|
|
73
|
+
endpoint?: string;
|
|
73
74
|
/**
|
|
74
75
|
* The API key to use for authentication.
|
|
76
|
+
* @deprecated use @param clientFactory property instead
|
|
75
77
|
*/
|
|
76
|
-
apiKey
|
|
78
|
+
apiKey?: string;
|
|
77
79
|
/**
|
|
78
80
|
* A flag for whether to include personalized routes in service output - only works on XM Cloud
|
|
79
81
|
* turned off by default
|
|
80
82
|
*/
|
|
81
83
|
includePersonalizedRoutes?: boolean;
|
|
84
|
+
/**
|
|
85
|
+
* A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
|
|
86
|
+
* This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
|
|
87
|
+
*/
|
|
88
|
+
clientFactory?: GraphQLRequestClientFactory;
|
|
82
89
|
}
|
|
83
90
|
/**
|
|
84
91
|
* Object model of a site page item.
|