@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.6 → 21.7.0-canary.7

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 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,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Context = void 0;
4
+ var context_1 = require("./context");
5
+ Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
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.PosResolver = 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.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = void 0;
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; } });
@@ -78,7 +78,6 @@ Object.defineProperty(exports, "getPersonalizedRewrite", { enumerable: true, get
78
78
  Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true, get: function () { return personalize_1.getPersonalizedRewriteData; } });
79
79
  Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return personalize_1.normalizePersonalizedRewrite; } });
80
80
  Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return personalize_1.CdpHelper; } });
81
- Object.defineProperty(exports, "PosResolver", { enumerable: true, get: function () { return personalize_1.PosResolver; } });
82
81
  var component_props_service_1 = require("./services/component-props-service");
83
82
  Object.defineProperty(exports, "ComponentPropsService", { enumerable: true, get: function () { return component_props_service_1.ComponentPropsService; } });
84
83
  var disconnected_sitemap_service_1 = require("./services/disconnected-sitemap-service");
@@ -116,6 +115,8 @@ const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
116
115
  exports.BYOCWrapper = BYOCWrapper;
117
116
  var ComponentBuilder_1 = require("./ComponentBuilder");
118
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; } });
119
120
  var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
120
121
  Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return sitecore_jss_react_1.Image; } });
121
122
  Object.defineProperty(exports, "Text", { enumerable: true, get: function () { return sitecore_jss_react_1.Text; } });
@@ -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 engage_1 = require("@sitecore/engage");
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
- const engageServer = this.initializeEngageServer(hostname, site, language);
66
- // creates the browser ID cookie on the server side
67
- // and includes the cookie in the response header
68
- try {
69
- yield engageServer.handleCookie(req, response, timeout);
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 CDP
73
+ // Execute targeted experience in Personalize SDK
86
74
  // eslint-disable-next-line no-useless-catch
87
75
  try {
88
- variantId = (yield engageServer.personalize(personalizationData, req, timeout)).variantId;
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;
@@ -132,17 +121,29 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
132
121
  }
133
122
  });
134
123
  }
135
- initializeEngageServer(hostName, site, language) {
136
- const engageServer = (0, engage_1.initServer)({
137
- clientKey: this.config.cdpConfig.clientKey,
138
- targetURL: this.config.cdpConfig.endpoint,
139
- pointOfSale: this.config.getPointOfSale
140
- ? this.config.getPointOfSale(site, language)
141
- : personalize_1.PosResolver.resolve(site, language),
142
- cookieDomain: hostName,
143
- forceServerCookieMode: true,
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));
144
146
  });
145
- return engageServer;
146
147
  }
147
148
  getExperienceParams(req) {
148
149
  const utm = {
@@ -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';
package/dist/esm/index.js CHANGED
@@ -24,7 +24,7 @@ export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChi
24
24
  export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
25
25
  export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
26
26
  export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
27
- export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
27
+ export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
28
28
  export { ComponentPropsService } from './services/component-props-service';
29
29
  export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
30
30
  export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
@@ -41,4 +41,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
41
41
  export { FEaaSWrapper };
42
42
  export { BYOCWrapper };
43
43
  export { ComponentBuilder } from './ComponentBuilder';
44
+ export { Context } from './context';
44
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';
@@ -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, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
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 { initServer } from '@sitecore/engage';
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
- const engageServer = this.initializeEngageServer(hostname, site, language);
63
- // creates the browser ID cookie on the server side
64
- // and includes the cookie in the response header
65
- try {
66
- yield engageServer.handleCookie(req, response, timeout);
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 CDP
70
+ // Execute targeted experience in Personalize SDK
83
71
  // eslint-disable-next-line no-useless-catch
84
72
  try {
85
- variantId = (yield engageServer.personalize(personalizationData, req, timeout)).variantId;
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;
@@ -129,17 +118,29 @@ export class PersonalizeMiddleware extends MiddlewareBase {
129
118
  }
130
119
  });
131
120
  }
132
- initializeEngageServer(hostName, site, language) {
133
- const engageServer = initServer({
134
- clientKey: this.config.cdpConfig.clientKey,
135
- targetURL: this.config.cdpConfig.endpoint,
136
- pointOfSale: this.config.getPointOfSale
137
- ? this.config.getPointOfSale(site, language)
138
- : PosResolver.resolve(site, language),
139
- cookieDomain: hostName,
140
- forceServerCookieMode: true,
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));
141
143
  });
142
- return engageServer;
143
144
  }
144
145
  getExperienceParams(req) {
145
146
  const utm = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore-jss/sitecore-jss-nextjs",
3
- "version": "21.7.0-canary.6",
3
+ "version": "21.7.0-canary.7",
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/engage": "^1.4.1",
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/engage": "^1.4.1",
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.7.0-canary.6",
76
- "@sitecore-jss/sitecore-jss-dev-tools": "^21.7.0-canary.6",
77
- "@sitecore-jss/sitecore-jss-react": "^21.7.0-canary.6",
76
+ "@sitecore-jss/sitecore-jss": "^21.7.0-canary.7",
77
+ "@sitecore-jss/sitecore-jss-dev-tools": "^21.7.0-canary.7",
78
+ "@sitecore-jss/sitecore-jss-react": "^21.7.0-canary.7",
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": "3468861efc54046977809988c5a6d0745a40aacb",
87
+ "gitHead": "c55bf6138cd4388c009a16c17475c65147f4d0b6",
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';
package/types/index.d.ts CHANGED
@@ -12,7 +12,7 @@ export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutService
12
12
  export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
13
13
  export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
14
14
  export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
15
- export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
15
+ export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
16
16
  export { ComponentPropsCollection, ComponentPropsError, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
17
17
  export { ModuleFactory, Module } from './sharedTypes/module-factory';
18
18
  export { ComponentPropsService } from './services/component-props-service';
@@ -32,4 +32,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
32
32
  export { FEaaSWrapper };
33
33
  export { BYOCWrapper };
34
34
  export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
35
+ export { Context, ContextConfig, SDK } from './context';
35
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';
@@ -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 CDP API endpoint
6
+ * Your Sitecore Edge Platform endpoint
7
+ * Default is https://edge-platform.sitecorecloud.io
9
8
  */
10
- endpoint: string;
9
+ sitecoreEdgeUrl?: string;
11
10
  /**
12
- * The client key to use for authentication
11
+ * Your unified Sitecore Edge Context Id
13
12
  */
14
- clientKey: string;
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 initializeEngageServer(hostName: string, site: SiteInfo, language: string): EngageServer;
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;