@sitecore-jss/sitecore-jss-react 22.2.0-canary.9 → 22.3.0-canary.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/dist/cjs/components/EditingScripts.js +5 -3
  2. package/dist/cjs/components/FieldMetadata.js +3 -2
  3. package/dist/cjs/components/PlaceholderMetadata.js +6 -9
  4. package/dist/cjs/index.js +3 -2
  5. package/dist/esm/components/EditingScripts.js +5 -3
  6. package/dist/esm/components/FieldMetadata.js +3 -2
  7. package/dist/esm/components/PlaceholderMetadata.js +4 -7
  8. package/dist/esm/index.js +1 -1
  9. package/package.json +3 -3
  10. package/types/components/PlaceholderCommon.d.ts +2 -2
  11. package/types/index.d.ts +1 -1
package/dist/cjs/components/EditingScripts.js CHANGED
@@ -7,6 +7,7 @@ exports.EditingScripts = void 0;
7
7
  const react_1 = __importDefault(require("react"));
8
8
  const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
9
9
  const withSitecoreContext_1 = require("../enhancers/withSitecoreContext");
10
+ const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
10
11
  /**
11
12
  * Renders client scripts and data for editing/preview mode in Pages.
12
13
  * This script is only rendered when EditMode is Metadata, otherwise it renders nothing.
@@ -14,13 +15,14 @@ const withSitecoreContext_1 = require("../enhancers/withSitecoreContext");
14
15
  const EditingScripts = () => {
15
16
  const { sitecoreContext: { pageState, editMode, clientData, clientScripts }, } = (0, withSitecoreContext_1.useSitecoreContext)();
16
17
  // Don't render anything if not in editing/preview mode
17
- if (pageState === layout_1.LayoutServicePageState.Normal)
18
+ if (pageState === layout_1.LayoutServicePageState.Normal || pageState === layout_1.LayoutServicePageState.Preview) {
18
19
  return react_1.default.createElement(react_1.default.Fragment, null);
20
+ }
19
21
  if (editMode === layout_1.EditMode.Metadata) {
22
+ const jssClientData = Object.assign(Object.assign({}, clientData), (0, editing_1.getJssPagesClientData)());
20
23
  return (react_1.default.createElement(react_1.default.Fragment, null, clientScripts === null || clientScripts === void 0 ? void 0 :
21
24
  clientScripts.map((src, index) => (react_1.default.createElement("script", { src: src, key: index }))),
22
- clientData &&
23
- Object.keys(clientData).map((id) => (react_1.default.createElement("script", { key: id, id: id, type: "application/json", dangerouslySetInnerHTML: { __html: JSON.stringify(clientData[id]) } })))));
25
+ Object.keys(jssClientData).map((id) => (react_1.default.createElement("script", { key: id, id: id, type: "application/json", dangerouslySetInnerHTML: { __html: JSON.stringify(jssClientData[id]) } })))));
24
26
  }
25
27
  return react_1.default.createElement(react_1.default.Fragment, null);
26
28
  };
package/dist/cjs/components/FieldMetadata.js CHANGED
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.FieldMetadata = void 0;
7
7
  const react_1 = __importDefault(require("react"));
8
8
  const prop_types_1 = __importDefault(require("prop-types"));
9
+ const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
9
10
  /**
10
11
  * The component which renders field metadata markup
11
12
  * @param {FieldMetadataProps} props the props of the component
@@ -18,8 +19,8 @@ const FieldMetadata = (props) => {
18
19
  chrometype: 'field',
19
20
  className: 'scpm',
20
21
  };
21
- const codeOpenAttributes = Object.assign(Object.assign({}, attributes), { kind: 'open' });
22
- const codeCloseAttributes = Object.assign(Object.assign({}, attributes), { kind: 'close' });
22
+ const codeOpenAttributes = Object.assign(Object.assign({}, attributes), { kind: editing_1.MetadataKind.Open });
23
+ const codeCloseAttributes = Object.assign(Object.assign({}, attributes), { kind: editing_1.MetadataKind.Close });
23
24
  return (react_1.default.createElement(react_1.default.Fragment, null,
24
25
  react_1.default.createElement("code", Object.assign({}, codeOpenAttributes), data),
25
26
  props.children,
package/dist/cjs/components/PlaceholderMetadata.js CHANGED
@@ -6,10 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.PlaceholderMetadata = void 0;
7
7
  const react_1 = __importDefault(require("react"));
8
8
  const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
9
- /**
10
- * default value of uid for root placeholder when uid is not present.
11
- */
12
- const DEFAULT_PLACEHOLDER_UID = '00000000-0000-0000-0000-000000000000';
9
+ const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
13
10
  /**
14
11
  * A React component to generate metadata blocks for a placeholder or rendering.
15
12
  * It utilizes dynamic attributes based on whether the component acts as a placeholder
@@ -30,14 +27,14 @@ const PlaceholderMetadata = ({ rendering, placeholderName, children, }) => {
30
27
  className: 'scpm',
31
28
  kind: kind,
32
29
  };
33
- if (kind === 'open') {
30
+ if (kind === editing_1.MetadataKind.Open) {
34
31
  if (chrometype === 'placeholder' && placeholderName) {
35
32
  let phId = '';
36
33
  for (const placeholder of Object.keys(rendering.placeholders)) {
37
34
  if (placeholderName === placeholder) {
38
35
  phId = id
39
36
  ? `${placeholderName}_${id}`
40
- : `${placeholderName}_${DEFAULT_PLACEHOLDER_UID}`;
37
+ : `${placeholderName}_${editing_1.DEFAULT_PLACEHOLDER_UID}`;
41
38
  break;
42
39
  }
43
40
  // Check if the placeholder is a dynamic placeholder
@@ -45,7 +42,7 @@ const PlaceholderMetadata = ({ rendering, placeholderName, children, }) => {
45
42
  const pattern = (0, layout_1.getDynamicPlaceholderPattern)(placeholder);
46
43
  // Check if the placeholder matches the dynamic placeholder pattern
47
44
  if (pattern.test(placeholderName)) {
48
- phId = id ? `${placeholder}_${id}` : `${placeholder}_${DEFAULT_PLACEHOLDER_UID}`;
45
+ phId = id ? `${placeholder}_${id}` : `${placeholder}_${editing_1.DEFAULT_PLACEHOLDER_UID}`;
49
46
  break;
50
47
  }
51
48
  }
@@ -59,9 +56,9 @@ const PlaceholderMetadata = ({ rendering, placeholderName, children, }) => {
59
56
  return attributes;
60
57
  };
61
58
  const renderComponent = (uid, placeholderName) => (react_1.default.createElement(react_1.default.Fragment, null,
62
- react_1.default.createElement("code", Object.assign({}, getCodeBlockAttributes('open', uid, placeholderName))),
59
+ react_1.default.createElement("code", Object.assign({}, getCodeBlockAttributes(editing_1.MetadataKind.Open, uid, placeholderName))),
63
60
  children,
64
- react_1.default.createElement("code", Object.assign({}, getCodeBlockAttributes('close', uid, placeholderName)))));
61
+ react_1.default.createElement("code", Object.assign({}, getCodeBlockAttributes(editing_1.MetadataKind.Close, uid, placeholderName)))));
65
62
  return react_1.default.createElement(react_1.default.Fragment, null, renderComponent(rendering.uid, placeholderName));
66
63
  };
67
64
  exports.PlaceholderMetadata = PlaceholderMetadata;
package/dist/cjs/index.js CHANGED
@@ -1,11 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EditingScripts = exports.withEmptyFieldEditingComponent = exports.withFieldMetadata = exports.ComponentBuilder = exports.EditFrame = exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.LinkPropTypes = exports.Link = exports.BYOCWrapper = exports.fetchBYOCComponentServerProps = exports.BYOCComponent = exports.FEaaSWrapper = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.DateField = exports.Text = exports.RichTextPropTypes = exports.RichText = exports.getEEMarkup = exports.Image = exports.Placeholder = exports.mediaApi = exports.GraphQLRequestClient = exports.DefaultRetryStrategy = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.EditMode = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.getComponentLibraryStylesheetLinks = exports.getContentStylesheetLink = exports.DefaultEditFrameButtons = exports.DefaultEditFrameButton = exports.resetEditorChromes = exports.isEditorActive = exports.ClientError = exports.enableDebug = exports.constants = void 0;
4
- exports.DefaultEmptyFieldEditingComponentImage = exports.DefaultEmptyFieldEditingComponentText = void 0;
3
+ exports.withEmptyFieldEditingComponent = exports.withFieldMetadata = exports.ComponentBuilder = exports.EditFrame = exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.LinkPropTypes = exports.Link = exports.BYOCWrapper = exports.fetchBYOCComponentServerProps = exports.BYOCComponent = exports.FEaaSWrapper = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.DateField = exports.Text = exports.RichTextPropTypes = exports.RichText = exports.getEEMarkup = exports.Image = exports.Placeholder = exports.mediaApi = exports.GraphQLRequestClient = exports.DefaultRetryStrategy = exports.RestDictionaryService = exports.GraphQLDictionaryService = exports.trackingApi = exports.EditMode = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = exports.getComponentLibraryStylesheetLinks = exports.getContentStylesheetLink = exports.DefaultEditFrameButtons = exports.DefaultEditFrameButton = exports.resetEditorChromes = exports.isEditorActive = exports.MemoryCacheClient = exports.ClientError = exports.enableDebug = exports.constants = void 0;
4
+ exports.DefaultEmptyFieldEditingComponentImage = exports.DefaultEmptyFieldEditingComponentText = exports.EditingScripts = void 0;
5
5
  var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
6
6
  Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
7
7
  Object.defineProperty(exports, "enableDebug", { enumerable: true, get: function () { return sitecore_jss_1.enableDebug; } });
8
8
  Object.defineProperty(exports, "ClientError", { enumerable: true, get: function () { return sitecore_jss_1.ClientError; } });
9
+ Object.defineProperty(exports, "MemoryCacheClient", { enumerable: true, get: function () { return sitecore_jss_1.MemoryCacheClient; } });
9
10
  var editing_1 = require("@sitecore-jss/sitecore-jss/editing");
10
11
  Object.defineProperty(exports, "isEditorActive", { enumerable: true, get: function () { return editing_1.isEditorActive; } });
11
12
  Object.defineProperty(exports, "resetEditorChromes", { enumerable: true, get: function () { return editing_1.resetEditorChromes; } });
package/dist/esm/components/EditingScripts.js CHANGED
@@ -1,6 +1,7 @@
1
1
  import React from 'react';
2
2
  import { EditMode, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
3
3
  import { useSitecoreContext } from '../enhancers/withSitecoreContext';
4
+ import { getJssPagesClientData } from '@sitecore-jss/sitecore-jss/editing';
4
5
  /**
5
6
  * Renders client scripts and data for editing/preview mode in Pages.
6
7
  * This script is only rendered when EditMode is Metadata, otherwise it renders nothing.
@@ -8,13 +9,14 @@ import { useSitecoreContext } from '../enhancers/withSitecoreContext';
8
9
  export const EditingScripts = () => {
9
10
  const { sitecoreContext: { pageState, editMode, clientData, clientScripts }, } = useSitecoreContext();
10
11
  // Don't render anything if not in editing/preview mode
11
- if (pageState === LayoutServicePageState.Normal)
12
+ if (pageState === LayoutServicePageState.Normal || pageState === LayoutServicePageState.Preview) {
12
13
  return React.createElement(React.Fragment, null);
14
+ }
13
15
  if (editMode === EditMode.Metadata) {
16
+ const jssClientData = Object.assign(Object.assign({}, clientData), getJssPagesClientData());
14
17
  return (React.createElement(React.Fragment, null, clientScripts === null || clientScripts === void 0 ? void 0 :
15
18
  clientScripts.map((src, index) => (React.createElement("script", { src: src, key: index }))),
16
- clientData &&
17
- Object.keys(clientData).map((id) => (React.createElement("script", { key: id, id: id, type: "application/json", dangerouslySetInnerHTML: { __html: JSON.stringify(clientData[id]) } })))));
19
+ Object.keys(jssClientData).map((id) => (React.createElement("script", { key: id, id: id, type: "application/json", dangerouslySetInnerHTML: { __html: JSON.stringify(jssClientData[id]) } })))));
18
20
  }
19
21
  return React.createElement(React.Fragment, null);
20
22
  };
package/dist/esm/components/FieldMetadata.js CHANGED
@@ -1,5 +1,6 @@
1
1
  import React from 'react';
2
2
  import PropTypes from 'prop-types';
3
+ import { MetadataKind } from '@sitecore-jss/sitecore-jss/editing';
3
4
  /**
4
5
  * The component which renders field metadata markup
5
6
  * @param {FieldMetadataProps} props the props of the component
@@ -12,8 +13,8 @@ export const FieldMetadata = (props) => {
12
13
  chrometype: 'field',
13
14
  className: 'scpm',
14
15
  };
15
- const codeOpenAttributes = Object.assign(Object.assign({}, attributes), { kind: 'open' });
16
- const codeCloseAttributes = Object.assign(Object.assign({}, attributes), { kind: 'close' });
16
+ const codeOpenAttributes = Object.assign(Object.assign({}, attributes), { kind: MetadataKind.Open });
17
+ const codeCloseAttributes = Object.assign(Object.assign({}, attributes), { kind: MetadataKind.Close });
17
18
  return (React.createElement(React.Fragment, null,
18
19
  React.createElement("code", Object.assign({}, codeOpenAttributes), data),
19
20
  props.children,
package/dist/esm/components/PlaceholderMetadata.js CHANGED
@@ -1,9 +1,6 @@
1
1
  import React from 'react';
2
2
  import { getDynamicPlaceholderPattern, isDynamicPlaceholder, } from '@sitecore-jss/sitecore-jss/layout';
3
- /**
4
- * default value of uid for root placeholder when uid is not present.
5
- */
6
- const DEFAULT_PLACEHOLDER_UID = '00000000-0000-0000-0000-000000000000';
3
+ import { MetadataKind, DEFAULT_PLACEHOLDER_UID } from '@sitecore-jss/sitecore-jss/editing';
7
4
  /**
8
5
  * A React component to generate metadata blocks for a placeholder or rendering.
9
6
  * It utilizes dynamic attributes based on whether the component acts as a placeholder
@@ -24,7 +21,7 @@ export const PlaceholderMetadata = ({ rendering, placeholderName, children, }) =
24
21
  className: 'scpm',
25
22
  kind: kind,
26
23
  };
27
- if (kind === 'open') {
24
+ if (kind === MetadataKind.Open) {
28
25
  if (chrometype === 'placeholder' && placeholderName) {
29
26
  let phId = '';
30
27
  for (const placeholder of Object.keys(rendering.placeholders)) {
@@ -53,8 +50,8 @@ export const PlaceholderMetadata = ({ rendering, placeholderName, children, }) =
53
50
  return attributes;
54
51
  };
55
52
  const renderComponent = (uid, placeholderName) => (React.createElement(React.Fragment, null,
56
- React.createElement("code", Object.assign({}, getCodeBlockAttributes('open', uid, placeholderName))),
53
+ React.createElement("code", Object.assign({}, getCodeBlockAttributes(MetadataKind.Open, uid, placeholderName))),
57
54
  children,
58
- React.createElement("code", Object.assign({}, getCodeBlockAttributes('close', uid, placeholderName)))));
55
+ React.createElement("code", Object.assign({}, getCodeBlockAttributes(MetadataKind.Close, uid, placeholderName)))));
59
56
  return React.createElement(React.Fragment, null, renderComponent(rendering.uid, placeholderName));
60
57
  };
package/dist/esm/index.js CHANGED
@@ -1,4 +1,4 @@
1
- export { constants, enableDebug, ClientError } from '@sitecore-jss/sitecore-jss';
1
+ export { constants, enableDebug, ClientError, MemoryCacheClient, } from '@sitecore-jss/sitecore-jss';
2
2
  export { isEditorActive, resetEditorChromes, DefaultEditFrameButton, DefaultEditFrameButtons, } from '@sitecore-jss/sitecore-jss/editing';
3
3
  export { getContentStylesheetLink, getComponentLibraryStylesheetLinks, LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, EditMode, } from '@sitecore-jss/sitecore-jss/layout';
4
4
  export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore-jss/sitecore-jss-react",
3
- "version": "22.2.0-canary.9",
3
+ "version": "22.3.0-canary.1",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "sideEffects": false,
@@ -61,14 +61,14 @@
61
61
  "react-dom": "^18.2.0"
62
62
  },
63
63
  "dependencies": {
64
- "@sitecore-jss/sitecore-jss": "^22.2.0-canary.9",
64
+ "@sitecore-jss/sitecore-jss": "^22.3.0-canary.1",
65
65
  "fast-deep-equal": "^3.1.3",
66
66
  "prop-types": "^15.8.1",
67
67
  "style-attr": "^1.3.0"
68
68
  },
69
69
  "description": "",
70
70
  "types": "types/index.d.ts",
71
- "gitHead": "843696778d1ce2cb8cb4d0ff21bf60da5df3020e",
71
+ "gitHead": "204eb3427f26d4ba8c08f44cf9c772f19f2820a8",
72
72
  "files": [
73
73
  "dist",
74
74
  "types"
package/types/components/PlaceholderCommon.d.ts CHANGED
@@ -69,7 +69,7 @@ export interface PlaceholderProps {
69
69
  }
70
70
  export declare class PlaceholderCommon<T extends PlaceholderProps> extends React.Component<T> {
71
71
  static propTypes: {
72
- rendering: PropTypes.Validator<NonNullable<NonNullable<ComponentRendering | RouteData<Record<string, Field<import("@sitecore-jss/sitecore-jss/layout").GenericFieldValue> | Item | Item[]>>>>>;
72
+ rendering: PropTypes.Validator<NonNullable<NonNullable<ComponentRendering<import("@sitecore-jss/sitecore-jss/layout").ComponentFields> | RouteData<Record<string, Field<import("@sitecore-jss/sitecore-jss/layout").GenericFieldValue> | Item | Item[]>>>>>;
73
73
  fields: PropTypes.Requireable<{
74
74
  [x: string]: NonNullable<NonNullable<Field<import("@sitecore-jss/sitecore-jss/layout").GenericFieldValue> | Item[]>>;
75
75
  }>;
@@ -87,7 +87,7 @@ export declare class PlaceholderCommon<T extends PlaceholderProps> extends React
87
87
  error?: Error;
88
88
  }>;
89
89
  constructor(props: T);
90
- static getPlaceholderDataFromRenderingData(rendering: ComponentRendering | RouteData, name: string, editMode?: EditMode): (ComponentRendering | HtmlElementRendering)[];
90
+ static getPlaceholderDataFromRenderingData(rendering: ComponentRendering | RouteData, name: string, editMode?: EditMode): (ComponentRendering<import("@sitecore-jss/sitecore-jss/layout").ComponentFields> | HtmlElementRendering)[];
91
91
  componentDidMount(): void;
92
92
  componentDidUpdate(): void;
93
93
  componentDidCatch(error: Error): void;
package/types/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { constants, enableDebug, ClientError } from '@sitecore-jss/sitecore-jss';
1
+ export { constants, enableDebug, ClientError, CacheClient, CacheOptions, MemoryCacheClient, } from '@sitecore-jss/sitecore-jss';
2
2
  export { EnhancedOmit } from '@sitecore-jss/sitecore-jss/utils';
3
3
  export { isEditorActive, resetEditorChromes, DefaultEditFrameButton, DefaultEditFrameButtons, EditFrameDataSource, FieldEditButton, WebEditButton, EditButtonTypes, } from '@sitecore-jss/sitecore-jss/editing';
4
4
  export { getContentStylesheetLink, getComponentLibraryStylesheetLinks, LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, RestLayoutService, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, EditMode, } from '@sitecore-jss/sitecore-jss/layout';