@sitecore-jss/sitecore-jss-nextjs 22.4.1-canary.2 → 22.5.0-beta.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.
Files changed (10) hide show
  1. package/dist/cjs/editing/editing-render-middleware.js +54 -18
  2. package/dist/cjs/editing/index.js +6 -1
  3. package/dist/cjs/index.js +5 -2
  4. package/dist/esm/editing/editing-render-middleware.js +53 -18
  5. package/dist/esm/editing/index.js +2 -1
  6. package/dist/esm/index.js +2 -1
  7. package/package.json +5 -5
  8. package/types/editing/editing-render-middleware.d.ts +23 -2
  9. package/types/editing/index.d.ts +2 -1
  10. package/types/index.d.ts +2 -1
package/dist/cjs/editing/editing-render-middleware.js CHANGED
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
9
9
  });
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.EditingRenderMiddleware = exports.MetadataHandler = exports.isEditingMetadataPreviewData = exports.ChromesHandler = void 0;
12
+ exports.EditingRenderMiddleware = exports.MetadataHandler = exports.isComponentLibraryPreviewData = exports.isEditingMetadataPreviewData = exports.ChromesHandler = void 0;
13
13
  const constants_1 = require("next/constants");
14
14
  const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
15
15
  const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
@@ -187,6 +187,19 @@ const isEditingMetadataPreviewData = (data) => {
187
187
  data.editMode === layout_1.EditMode.Metadata);
188
188
  };
189
189
  exports.isEditingMetadataPreviewData = isEditingMetadataPreviewData;
190
+ /**
191
+ * Type guard for Component Library mode
192
+ * @param {object} data preview data to check
193
+ * @returns true if the data is EditingMetadataPreviewData
194
+ * @see EditingMetadataPreviewData
195
+ */
196
+ const isComponentLibraryPreviewData = (data) => {
197
+ return (typeof data === 'object' &&
198
+ data !== null &&
199
+ 'mode' in data &&
200
+ data.mode === 'library');
201
+ };
202
+ exports.isComponentLibraryPreviewData = isComponentLibraryPreviewData;
190
203
  /**
191
204
  * Handler for the Editing Metadata GET requests.
192
205
  * This handler is responsible for redirecting the request to the page route.
@@ -200,13 +213,17 @@ class MetadataHandler {
200
213
  var _a, _b, _c;
201
214
  const { query } = req;
202
215
  const startTimestamp = Date.now();
203
- const requiredQueryParams = [
216
+ const mode = query.mode;
217
+ const metadataDefaultRequiredParams = ['sc_site', 'sc_itemid', 'sc_lang', 'route', 'mode'];
218
+ const metadataComponentRequiredParams = [
204
219
  'sc_site',
205
220
  'sc_itemid',
221
+ 'sc_renderingId',
222
+ 'sc_uid',
206
223
  'sc_lang',
207
- 'route',
208
224
  'mode',
209
225
  ];
226
+ const requiredQueryParams = mode === 'library' ? metadataComponentRequiredParams : metadataDefaultRequiredParams;
210
227
  const missingQueryParams = requiredQueryParams.filter((param) => !query[param]);
211
228
  // Validate query parameters
212
229
  if (missingQueryParams.length) {
@@ -215,21 +232,40 @@ class MetadataHandler {
215
232
  html: `<html><body>Missing required query parameters: ${missingQueryParams.join(', ')}</body></html>`,
216
233
  });
217
234
  }
218
- res.setPreviewData({
219
- site: query.sc_site,
220
- itemId: query.sc_itemid,
221
- language: query.sc_lang,
222
- // for sc_variantId we may employ multiple variants (page-layout + component level)
223
- variantIds: ((_a = query.sc_variant) === null || _a === void 0 ? void 0 : _a.split(',')) || [personalize_1.DEFAULT_VARIANT],
224
- version: query.sc_version,
225
- editMode: layout_1.EditMode.Metadata,
226
- pageState: query.mode,
227
- layoutKind: query.sc_layoutKind,
228
- },
229
- // Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
230
- {
231
- maxAge: 3,
232
- });
235
+ if (mode === 'library') {
236
+ // dedicated route and layout to SSR component library
237
+ query.route = '/component-library/render';
238
+ res.setPreviewData({
239
+ itemId: query.sc_itemid,
240
+ componentUid: query.sc_uid,
241
+ renderingId: query.sc_renderingId,
242
+ language: query.sc_lang,
243
+ site: query.sc_site,
244
+ pageState: layout_1.LayoutServicePageState.Normal,
245
+ mode: 'library',
246
+ dataSourceId: query.sc_datasourceId,
247
+ version: query.sc_version,
248
+ }, {
249
+ maxAge: 3,
250
+ });
251
+ }
252
+ else {
253
+ res.setPreviewData({
254
+ site: query.sc_site,
255
+ itemId: query.sc_itemid,
256
+ language: query.sc_lang,
257
+ // for sc_variantId we may employ multiple variants (page-layout + component level)
258
+ variantIds: ((_a = query.sc_variant) === null || _a === void 0 ? void 0 : _a.split(',')) || [personalize_1.DEFAULT_VARIANT],
259
+ version: query.sc_version,
260
+ editMode: layout_1.EditMode.Metadata,
261
+ pageState: query.mode,
262
+ layoutKind: query.sc_layoutKind,
263
+ },
264
+ // Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
265
+ {
266
+ maxAge: 3,
267
+ });
268
+ }
233
269
  // Cookies with the SameSite=Lax policy set by Next.js setPreviewData function causes CORS issue
234
270
  // when Next.js preview mode is activated, resulting the page to render in normal mode instead.
235
271
  // By replacing it with "SameSite=None; Secure", we ensure cookies are correctly sent with
package/dist/cjs/editing/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EditingConfigMiddleware = exports.FEAASRenderMiddleware = exports.VercelEditingDataCache = exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.isEditingMetadataPreviewData = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = exports.GraphQLEditingService = void 0;
3
+ exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.EditingConfigMiddleware = exports.FEAASRenderMiddleware = exports.VercelEditingDataCache = exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.isComponentLibraryPreviewData = exports.isEditingMetadataPreviewData = exports.EditingRenderMiddleware = exports.EditingDataMiddleware = exports.EditingDataDiskCache = exports.GraphQLEditingService = void 0;
4
4
  var editing_1 = require("@sitecore-jss/sitecore-jss/editing");
5
5
  Object.defineProperty(exports, "GraphQLEditingService", { enumerable: true, get: function () { return editing_1.GraphQLEditingService; } });
6
6
  var editing_data_cache_1 = require("./editing-data-cache");
@@ -10,6 +10,7 @@ Object.defineProperty(exports, "EditingDataMiddleware", { enumerable: true, get:
10
10
  var editing_render_middleware_1 = require("./editing-render-middleware");
11
11
  Object.defineProperty(exports, "EditingRenderMiddleware", { enumerable: true, get: function () { return editing_render_middleware_1.EditingRenderMiddleware; } });
12
12
  Object.defineProperty(exports, "isEditingMetadataPreviewData", { enumerable: true, get: function () { return editing_render_middleware_1.isEditingMetadataPreviewData; } });
13
+ Object.defineProperty(exports, "isComponentLibraryPreviewData", { enumerable: true, get: function () { return editing_render_middleware_1.isComponentLibraryPreviewData; } });
13
14
  var editing_data_service_1 = require("./editing-data-service");
14
15
  Object.defineProperty(exports, "BasicEditingDataService", { enumerable: true, get: function () { return editing_data_service_1.BasicEditingDataService; } });
15
16
  Object.defineProperty(exports, "ServerlessEditingDataService", { enumerable: true, get: function () { return editing_data_service_1.ServerlessEditingDataService; } });
@@ -20,3 +21,7 @@ var feaas_render_middleware_1 = require("./feaas-render-middleware");
20
21
  Object.defineProperty(exports, "FEAASRenderMiddleware", { enumerable: true, get: function () { return feaas_render_middleware_1.FEAASRenderMiddleware; } });
21
22
  var editing_config_middleware_1 = require("./editing-config-middleware");
22
23
  Object.defineProperty(exports, "EditingConfigMiddleware", { enumerable: true, get: function () { return editing_config_middleware_1.EditingConfigMiddleware; } });
24
+ var layout_1 = require("@sitecore-jss/sitecore-jss/layout");
25
+ Object.defineProperty(exports, "RenderingType", { enumerable: true, get: function () { return layout_1.RenderingType; } });
26
+ Object.defineProperty(exports, "EDITING_COMPONENT_PLACEHOLDER", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_PLACEHOLDER; } });
27
+ Object.defineProperty(exports, "EDITING_COMPONENT_ID", { enumerable: true, get: function () { return layout_1.EDITING_COMPONENT_ID; } });
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.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = exports.NextImage = 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.getGroomedVariantIds = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.EditMode = exports.getContentStylesheetLink = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.MemoryCacheClient = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.constants = void 0;
27
- exports.EditingScripts = exports.withEmptyFieldEditingComponent = exports.withFieldMetadata = exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.DefaultEmptyFieldEditingComponentText = exports.DefaultEmptyFieldEditingComponentImage = exports.File = exports.getComponentLibraryStylesheetLinks = exports.BYOCComponent = void 0;
26
+ exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = exports.NextImage = 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.getGroomedVariantIds = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.personalizeLayout = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.mediaApi = exports.RestComponentLayoutService = exports.EditMode = exports.getContentStylesheetLink = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.MemoryCacheClient = exports.debug = exports.enableDebug = exports.NativeDataFetcher = exports.constants = void 0;
27
+ exports.EditingScripts = exports.withEmptyFieldEditingComponent = exports.withFieldMetadata = exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.DefaultEmptyFieldEditingComponentText = exports.DefaultEmptyFieldEditingComponentImage = exports.ComponentLibraryLayout = exports.File = exports.getComponentLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = 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, "NativeDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.NativeDataFetcher; } });
@@ -39,6 +39,8 @@ Object.defineProperty(exports, "getChildPlaceholder", { enumerable: true, get: f
39
39
  Object.defineProperty(exports, "getFieldValue", { enumerable: true, get: function () { return layout_1.getFieldValue; } });
40
40
  Object.defineProperty(exports, "getContentStylesheetLink", { enumerable: true, get: function () { return layout_1.getContentStylesheetLink; } });
41
41
  Object.defineProperty(exports, "EditMode", { enumerable: true, get: function () { return layout_1.EditMode; } });
42
+ var editing_1 = require("@sitecore-jss/sitecore-jss/editing");
43
+ Object.defineProperty(exports, "RestComponentLayoutService", { enumerable: true, get: function () { return editing_1.RestComponentLayoutService; } });
42
44
  var media_1 = require("@sitecore-jss/sitecore-jss/media");
43
45
  Object.defineProperty(exports, "mediaApi", { enumerable: true, get: function () { return media_1.mediaApi; } });
44
46
  var tracking_1 = require("@sitecore-jss/sitecore-jss/tracking");
@@ -98,6 +100,7 @@ Object.defineProperty(exports, "fetchFEaaSComponentServerProps", { enumerable: t
98
100
  Object.defineProperty(exports, "BYOCComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCComponent; } });
99
101
  Object.defineProperty(exports, "getComponentLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getComponentLibraryStylesheetLinks; } });
100
102
  Object.defineProperty(exports, "File", { enumerable: true, get: function () { return sitecore_jss_react_1.File; } });
103
+ Object.defineProperty(exports, "ComponentLibraryLayout", { enumerable: true, get: function () { return sitecore_jss_react_1.ComponentLibraryLayout; } });
101
104
  Object.defineProperty(exports, "DefaultEmptyFieldEditingComponentImage", { enumerable: true, get: function () { return sitecore_jss_react_1.DefaultEmptyFieldEditingComponentImage; } });
102
105
  Object.defineProperty(exports, "DefaultEmptyFieldEditingComponentText", { enumerable: true, get: function () { return sitecore_jss_react_1.DefaultEmptyFieldEditingComponentText; } });
103
106
  Object.defineProperty(exports, "VisitorIdentification", { enumerable: true, get: function () { return sitecore_jss_react_1.VisitorIdentification; } });
package/dist/esm/editing/editing-render-middleware.js CHANGED
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
9
9
  };
10
10
  import { STATIC_PROPS_ID, SERVER_PROPS_ID } from 'next/constants';
11
11
  import { NativeDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
12
- import { EditMode } from '@sitecore-jss/sitecore-jss/layout';
12
+ import { EditMode, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
13
13
  import { QUERY_PARAM_EDITING_SECRET, EDITING_ALLOWED_ORIGINS, } from '@sitecore-jss/sitecore-jss/editing';
14
14
  import { editingDataService } from './editing-data-service';
15
15
  import { getJssEditingSecret } from '../utils/utils';
@@ -182,6 +182,18 @@ export const isEditingMetadataPreviewData = (data) => {
182
182
  'editMode' in data &&
183
183
  data.editMode === EditMode.Metadata);
184
184
  };
185
+ /**
186
+ * Type guard for Component Library mode
187
+ * @param {object} data preview data to check
188
+ * @returns true if the data is EditingMetadataPreviewData
189
+ * @see EditingMetadataPreviewData
190
+ */
191
+ export const isComponentLibraryPreviewData = (data) => {
192
+ return (typeof data === 'object' &&
193
+ data !== null &&
194
+ 'mode' in data &&
195
+ data.mode === 'library');
196
+ };
185
197
  /**
186
198
  * Handler for the Editing Metadata GET requests.
187
199
  * This handler is responsible for redirecting the request to the page route.
@@ -195,13 +207,17 @@ export class MetadataHandler {
195
207
  var _a, _b, _c;
196
208
  const { query } = req;
197
209
  const startTimestamp = Date.now();
198
- const requiredQueryParams = [
210
+ const mode = query.mode;
211
+ const metadataDefaultRequiredParams = ['sc_site', 'sc_itemid', 'sc_lang', 'route', 'mode'];
212
+ const metadataComponentRequiredParams = [
199
213
  'sc_site',
200
214
  'sc_itemid',
215
+ 'sc_renderingId',
216
+ 'sc_uid',
201
217
  'sc_lang',
202
- 'route',
203
218
  'mode',
204
219
  ];
220
+ const requiredQueryParams = mode === 'library' ? metadataComponentRequiredParams : metadataDefaultRequiredParams;
205
221
  const missingQueryParams = requiredQueryParams.filter((param) => !query[param]);
206
222
  // Validate query parameters
207
223
  if (missingQueryParams.length) {
@@ -210,21 +226,40 @@ export class MetadataHandler {
210
226
  html: `<html><body>Missing required query parameters: ${missingQueryParams.join(', ')}</body></html>`,
211
227
  });
212
228
  }
213
- res.setPreviewData({
214
- site: query.sc_site,
215
- itemId: query.sc_itemid,
216
- language: query.sc_lang,
217
- // for sc_variantId we may employ multiple variants (page-layout + component level)
218
- variantIds: ((_a = query.sc_variant) === null || _a === void 0 ? void 0 : _a.split(',')) || [DEFAULT_VARIANT],
219
- version: query.sc_version,
220
- editMode: EditMode.Metadata,
221
- pageState: query.mode,
222
- layoutKind: query.sc_layoutKind,
223
- },
224
- // Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
225
- {
226
- maxAge: 3,
227
- });
229
+ if (mode === 'library') {
230
+ // dedicated route and layout to SSR component library
231
+ query.route = '/component-library/render';
232
+ res.setPreviewData({
233
+ itemId: query.sc_itemid,
234
+ componentUid: query.sc_uid,
235
+ renderingId: query.sc_renderingId,
236
+ language: query.sc_lang,
237
+ site: query.sc_site,
238
+ pageState: LayoutServicePageState.Normal,
239
+ mode: 'library',
240
+ dataSourceId: query.sc_datasourceId,
241
+ version: query.sc_version,
242
+ }, {
243
+ maxAge: 3,
244
+ });
245
+ }
246
+ else {
247
+ res.setPreviewData({
248
+ site: query.sc_site,
249
+ itemId: query.sc_itemid,
250
+ language: query.sc_lang,
251
+ // for sc_variantId we may employ multiple variants (page-layout + component level)
252
+ variantIds: ((_a = query.sc_variant) === null || _a === void 0 ? void 0 : _a.split(',')) || [DEFAULT_VARIANT],
253
+ version: query.sc_version,
254
+ editMode: EditMode.Metadata,
255
+ pageState: query.mode,
256
+ layoutKind: query.sc_layoutKind,
257
+ },
258
+ // Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
259
+ {
260
+ maxAge: 3,
261
+ });
262
+ }
228
263
  // Cookies with the SameSite=Lax policy set by Next.js setPreviewData function causes CORS issue
229
264
  // when Next.js preview mode is activated, resulting the page to render in normal mode instead.
230
265
  // By replacing it with "SameSite=None; Secure", we ensure cookies are correctly sent with
package/dist/esm/editing/index.js CHANGED
@@ -1,8 +1,9 @@
1
1
  export { GraphQLEditingService } from '@sitecore-jss/sitecore-jss/editing';
2
2
  export { EditingDataDiskCache } from './editing-data-cache';
3
3
  export { EditingDataMiddleware } from './editing-data-middleware';
4
- export { EditingRenderMiddleware, isEditingMetadataPreviewData, } from './editing-render-middleware';
4
+ export { EditingRenderMiddleware, isEditingMetadataPreviewData, isComponentLibraryPreviewData, } from './editing-render-middleware';
5
5
  export { BasicEditingDataService, ServerlessEditingDataService, editingDataService, } from './editing-data-service';
6
6
  export { VercelEditingDataCache } from './vercel-editing-data-cache';
7
7
  export { FEAASRenderMiddleware } from './feaas-render-middleware';
8
8
  export { EditingConfigMiddleware, } from './editing-config-middleware';
9
+ export { RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
package/dist/esm/index.js CHANGED
@@ -1,5 +1,6 @@
1
1
  export { constants, NativeDataFetcher, enableDebug, debug, MemoryCacheClient, } from '@sitecore-jss/sitecore-jss';
2
2
  export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, getContentStylesheetLink, EditMode, } from '@sitecore-jss/sitecore-jss/layout';
3
+ export { RestComponentLayoutService } from '@sitecore-jss/sitecore-jss/editing';
3
4
  export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
4
5
  export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
5
6
  export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
@@ -19,4 +20,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
19
20
  export { FEaaSWrapper };
20
21
  export { BYOCWrapper };
21
22
  export { ComponentBuilder } from './ComponentBuilder';
22
- export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';
23
+ export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, ComponentLibraryLayout, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore-jss/sitecore-jss-nextjs",
3
- "version": "22.4.1-canary.2",
3
+ "version": "22.5.0-beta.1",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "sideEffects": false,
@@ -73,9 +73,9 @@
73
73
  "react-dom": "^18.2.0"
74
74
  },
75
75
  "dependencies": {
76
- "@sitecore-jss/sitecore-jss": "^22.4.1-canary.2",
77
- "@sitecore-jss/sitecore-jss-dev-tools": "^22.4.1-canary.2",
78
- "@sitecore-jss/sitecore-jss-react": "^22.4.1-canary.2",
76
+ "@sitecore-jss/sitecore-jss": "^22.5.0-beta.1",
77
+ "@sitecore-jss/sitecore-jss-dev-tools": "^22.5.0-beta.1",
78
+ "@sitecore-jss/sitecore-jss-react": "^22.5.0-beta.1",
79
79
  "@vercel/kv": "^0.2.1",
80
80
  "prop-types": "^15.8.1",
81
81
  "regex-parser": "^2.2.11",
@@ -83,7 +83,7 @@
83
83
  },
84
84
  "description": "",
85
85
  "types": "types/index.d.ts",
86
- "gitHead": "7cec13189f26fb9287541720fd1491bfcc9c24b8",
86
+ "gitHead": "e080916b354c36e63f29f01fbcb87688d7f2b4cd",
87
87
  "files": [
88
88
  "dist",
89
89
  "types",
package/types/editing/editing-render-middleware.d.ts CHANGED
@@ -99,7 +99,7 @@ export type EditingRenderMiddlewareMetadataConfig = Pick<EditingRenderMiddleware
99
99
  /**
100
100
  * Next.js API request with Metadata query parameters.
101
101
  */
102
- type MetadataNextApiRequest = NextApiRequest & {
102
+ export type MetadataNextApiRequest = NextApiRequest & {
103
103
  query: RenderMetadataQueryParams;
104
104
  };
105
105
  /**
@@ -115,6 +115,21 @@ export type EditingMetadataPreviewData = {
115
115
  version?: string;
116
116
  layoutKind?: LayoutKind;
117
117
  };
118
+ /**
119
+ * Data for Component Library rendering mode
120
+ */
121
+ export interface ComponentLibraryRenderPreviewData {
122
+ site: string;
123
+ itemId: string;
124
+ renderingId: string;
125
+ componentUid: string;
126
+ language: string;
127
+ pageState: LayoutServicePageState;
128
+ mode?: 'library';
129
+ variant?: string;
130
+ version?: string;
131
+ dataSourceId?: string;
132
+ }
118
133
  /**
119
134
  * Type guard for EditingMetadataPreviewData
120
135
  * @param {object} data preview data to check
@@ -122,6 +137,13 @@ export type EditingMetadataPreviewData = {
122
137
  * @see EditingMetadataPreviewData
123
138
  */
124
139
  export declare const isEditingMetadataPreviewData: (data: unknown) => data is EditingMetadataPreviewData;
140
+ /**
141
+ * Type guard for Component Library mode
142
+ * @param {object} data preview data to check
143
+ * @returns true if the data is EditingMetadataPreviewData
144
+ * @see EditingMetadataPreviewData
145
+ */
146
+ export declare const isComponentLibraryPreviewData: (data: unknown) => data is ComponentLibraryRenderPreviewData;
125
147
  /**
126
148
  * Handler for the Editing Metadata GET requests.
127
149
  * This handler is responsible for redirecting the request to the page route.
@@ -154,4 +176,3 @@ export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
154
176
  getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
155
177
  private handler;
156
178
  }
157
- export {};
package/types/editing/index.d.ts CHANGED
@@ -2,8 +2,9 @@ export { GraphQLEditingService } from '@sitecore-jss/sitecore-jss/editing';
2
2
  export { EditingData } from './editing-data';
3
3
  export { EditingDataCache, EditingDataDiskCache } from './editing-data-cache';
4
4
  export { EditingDataMiddleware, EditingDataMiddlewareConfig } from './editing-data-middleware';
5
- export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, EditingMetadataPreviewData, isEditingMetadataPreviewData, } from './editing-render-middleware';
5
+ export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, EditingMetadataPreviewData, isEditingMetadataPreviewData, isComponentLibraryPreviewData, } from './editing-render-middleware';
6
6
  export { EditingPreviewData, EditingDataService, BasicEditingDataService, BasicEditingDataServiceConfig, ServerlessEditingDataService, ServerlessEditingDataServiceConfig, editingDataService, } from './editing-data-service';
7
7
  export { VercelEditingDataCache } from './vercel-editing-data-cache';
8
8
  export { FEAASRenderMiddleware, FEAASRenderMiddlewareConfig } from './feaas-render-middleware';
9
9
  export { EditingConfigMiddleware, EditingConfigMiddlewareConfig, } from './editing-config-middleware';
10
+ export { RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
package/types/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  export { constants, HttpDataFetcher, NativeDataFetcher, NativeDataFetcherConfig, NativeDataFetcherResponse, NativeDataFetcherError, HTMLLink, enableDebug, debug, CacheClient, CacheOptions, MemoryCacheClient, } from '@sitecore-jss/sitecore-jss';
2
2
  export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, RestLayoutService, RestLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, getContentStylesheetLink, EditMode, } from '@sitecore-jss/sitecore-jss/layout';
3
+ export { RestComponentLayoutService } from '@sitecore-jss/sitecore-jss/editing';
3
4
  export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
4
5
  export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
5
6
  export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
@@ -22,4 +23,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
22
23
  export { FEaaSWrapper };
23
24
  export { BYOCWrapper };
24
25
  export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
25
- export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getComponentLibraryStylesheetLinks, File, FileField, RichTextField, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreContextOptions, WithSitecoreContextProps, WithSitecoreContextHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';
26
+ export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getComponentLibraryStylesheetLinks, File, FileField, RichTextField, ComponentLibraryLayout, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreContextOptions, WithSitecoreContextProps, WithSitecoreContextHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';