@sitecore-jss/sitecore-jss-react 22.3.0-canary.9 → 22.3.1-canary.10

package/dist/cjs/components/FEaaSComponent.js

@@ -118,7 +118,6 @@ function fetchComponentTemplate(src, params, revisionFallback) {
 /**
  * Fetches component data based on the provided data options.
  * This function asynchronously fetches data using the FEAAS.DataSettings.fetch method.
- *
  * @param {FEAAS.DataOptions} dataOptions - Options to customize data fetching.
  * @returns {Promise<FEAAS.DataScopes>} A promise that resolves with the fetched data,
  * or rejects with an error if data fetching encounters an issue.

package/dist/cjs/components/PlaceholderMetadata.js

@@ -11,7 +11,6 @@ const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
  * A React component to generate metadata blocks for a placeholder or rendering.
  * It utilizes dynamic attributes based on whether the component acts as a placeholder
  * or as a rendering to properly render the surrounding code blocks.
- *
  * @param {object} props The properties passed to the component.
  * @param {ComponentRendering} props.rendering The rendering data.
  * @param {string} [props.placeholderName] The name of the placeholder.

package/dist/cjs/enhancers/withSitecoreContext.js

@@ -23,24 +23,20 @@ exports.withSitecoreContext = withSitecoreContext;
  * - pageEditing - Provided by Layout Service, a boolean indicating whether the route is being accessed via the Experience Editor.
  * - pageState - Like pageEditing, but a string: normal, preview or edit.
  * - site - Provided by Layout Service, an object containing the name of the current Sitecore site context.
- *
  * @see https://jss.sitecore.com/docs/techniques/extending-layout-service/layoutservice-extending-context
- *
  * @param {WithSitecoreContextOptions} [options] hook options
- *
  * @example
  * const EditMode = () => {
  *    const { sitecoreContext } = useSitecoreContext();
  *    return <span>Edit Mode is {sitecoreContext.pageEditing ? 'active' : 'inactive'}</span>
  * }
- *
  * @example
  * const EditMode = () => {
  *    const { sitecoreContext, updateSitecoreContext } = useSitecoreContext({ updatable: true });
  *    const onClick = () => updateSitecoreContext({ pageEditing: true });
  *    return <span onClick={onClick}>Edit Mode is {sitecoreContext.pageEditing ? 'active' : 'inactive'}</span>
  * }
- * @returns {Object} { sitecoreContext, updateSitecoreContext }
+ * @returns {object} { sitecoreContext, updateSitecoreContext }
  */
 function useSitecoreContext(options) {
     const reactContext = react_1.default.useContext(SitecoreContext_1.SitecoreContextReactContext);

package/dist/cjs/utils.js

@@ -82,7 +82,7 @@ const addClassName = (otherAttrs) => {
 exports.addClassName = addClassName;
 /**
  * Converts the given tag attributes object to a string
- * @param {Object.<string, unknown>} attributes the attributes object
+ * @param {{[key: string]: unknown}} attributes the attributes object
  * @returns {string} string representation of the attributes
  */
 const getAttributesString = (attributes) => {

package/dist/esm/components/FEaaSComponent.js

@@ -87,7 +87,6 @@ function fetchComponentTemplate(src, params, revisionFallback) {
 /**
  * Fetches component data based on the provided data options.
  * This function asynchronously fetches data using the FEAAS.DataSettings.fetch method.
- *
  * @param {FEAAS.DataOptions} dataOptions - Options to customize data fetching.
  * @returns {Promise<FEAAS.DataScopes>} A promise that resolves with the fetched data,
  * or rejects with an error if data fetching encounters an issue.

package/dist/esm/components/PlaceholderMetadata.js

@@ -5,7 +5,6 @@ import { MetadataKind, DEFAULT_PLACEHOLDER_UID } from '@sitecore-jss/sitecore-js
  * A React component to generate metadata blocks for a placeholder or rendering.
  * It utilizes dynamic attributes based on whether the component acts as a placeholder
  * or as a rendering to properly render the surrounding code blocks.
- *
  * @param {object} props The properties passed to the component.
  * @param {ComponentRendering} props.rendering The rendering data.
  * @param {string} [props.placeholderName] The name of the placeholder.

package/dist/esm/enhancers/withSitecoreContext.js

@@ -16,24 +16,20 @@ export function withSitecoreContext(options) {
  * - pageEditing - Provided by Layout Service, a boolean indicating whether the route is being accessed via the Experience Editor.
  * - pageState - Like pageEditing, but a string: normal, preview or edit.
  * - site - Provided by Layout Service, an object containing the name of the current Sitecore site context.
- *
  * @see https://jss.sitecore.com/docs/techniques/extending-layout-service/layoutservice-extending-context
- *
  * @param {WithSitecoreContextOptions} [options] hook options
- *
  * @example
  * const EditMode = () => {
  *    const { sitecoreContext } = useSitecoreContext();
  *    return <span>Edit Mode is {sitecoreContext.pageEditing ? 'active' : 'inactive'}</span>
  * }
- *
  * @example
  * const EditMode = () => {
  *    const { sitecoreContext, updateSitecoreContext } = useSitecoreContext({ updatable: true });
  *    const onClick = () => updateSitecoreContext({ pageEditing: true });
  *    return <span onClick={onClick}>Edit Mode is {sitecoreContext.pageEditing ? 'active' : 'inactive'}</span>
  * }
- * @returns {Object} { sitecoreContext, updateSitecoreContext }
+ * @returns {object} { sitecoreContext, updateSitecoreContext }
  */
 export function useSitecoreContext(options) {
     const reactContext = React.useContext(SitecoreContextReactContext);

package/dist/esm/utils.js

@@ -75,7 +75,7 @@ export const addClassName = (otherAttrs) => {
 };
 /**
  * Converts the given tag attributes object to a string
- * @param {Object.<string, unknown>} attributes the attributes object
+ * @param {{[key: string]: unknown}} attributes the attributes object
  * @returns {string} string representation of the attributes
  */
 export const getAttributesString = (attributes) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-react",
-  "version": "22.3.0-canary.9",
+  "version": "22.3.1-canary.10",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -11,10 +11,10 @@
     "test": "mocha --require ts-node/register/transpile-only --require ./src/tests/shim.ts ./src/tests/jsdom-setup.ts ./src/tests/enzyme-setup.ts \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-react src/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-react src/index.ts --githubPages false"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "author": {
     "name": "Sitecore Corporation",
@@ -33,7 +33,7 @@
     "@types/mocha": "^10.0.1",
     "@types/node": "20.14.2",
     "@types/prop-types": "^15.7.5",
-    "@types/react": "^18.2.22",
+    "@types/react": "^18.2.45",
     "@types/react-dom": "^18.0.10",
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.9",
@@ -43,9 +43,9 @@
     "cheerio": "1.0.0-rc.12",
     "del-cli": "^5.0.0",
     "enzyme": "^3.11.0",
-    "eslint": "^8.28.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-react": "^7.31.11",
-    "jsdom": "^20.0.3",
+    "jsdom": "^25.0.1",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "react": "^18.2.0",
@@ -61,14 +61,14 @@
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.3.0-canary.9",
+    "@sitecore-jss/sitecore-jss": "^22.3.1-canary.10",
     "fast-deep-equal": "^3.1.3",
     "prop-types": "^15.8.1",
     "style-attr": "^1.3.0"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "80aab2e2e832a1a9ae024c771a955c2d403e63fe",
+  "gitHead": "501bf3b7c73be6cf633b4f86a9ca418c4d61745d",
   "files": [
     "dist",
     "types"

package/types/components/PlaceholderMetadata.d.ts

@@ -20,7 +20,6 @@ export type CodeBlockAttributes = {
  * A React component to generate metadata blocks for a placeholder or rendering.
  * It utilizes dynamic attributes based on whether the component acts as a placeholder
  * or as a rendering to properly render the surrounding code blocks.
- *
  * @param {object} props The properties passed to the component.
  * @param {ComponentRendering} props.rendering The rendering data.
  * @param {string} [props.placeholderName] The name of the placeholder.

package/types/enhancers/withEmptyFieldEditingComponent.d.ts

@@ -3,7 +3,7 @@ import React, { ComponentType } from 'react';
 import { GenericFieldValue, Field, FieldMetadata } from '@sitecore-jss/sitecore-jss/layout';
 /**
  * The HOC options
- * */
+ */
 export interface WithEmptyFieldEditingComponentOptions {
     /**
      * the default empty field component

package/types/enhancers/withSitecoreContext.d.ts

@@ -20,24 +20,20 @@ export declare function withSitecoreContext(options?: WithSitecoreContextOptions
  * - pageEditing - Provided by Layout Service, a boolean indicating whether the route is being accessed via the Experience Editor.
  * - pageState - Like pageEditing, but a string: normal, preview or edit.
  * - site - Provided by Layout Service, an object containing the name of the current Sitecore site context.
- *
  * @see https://jss.sitecore.com/docs/techniques/extending-layout-service/layoutservice-extending-context
- *
  * @param {WithSitecoreContextOptions} [options] hook options
- *
  * @example
  * const EditMode = () => {
  *    const { sitecoreContext } = useSitecoreContext();
  *    return <span>Edit Mode is {sitecoreContext.pageEditing ? 'active' : 'inactive'}</span>
  * }
- *
  * @example
  * const EditMode = () => {
  *    const { sitecoreContext, updateSitecoreContext } = useSitecoreContext({ updatable: true });
  *    const onClick = () => updateSitecoreContext({ pageEditing: true });
  *    return <span onClick={onClick}>Edit Mode is {sitecoreContext.pageEditing ? 'active' : 'inactive'}</span>
  * }
- * @returns {Object} { sitecoreContext, updateSitecoreContext }
+ * @returns {object} { sitecoreContext, updateSitecoreContext }
  */
 export declare function useSitecoreContext(options?: WithSitecoreContextOptions): {
     sitecoreContext: SitecoreContextValue;

package/types/utils.d.ts

@@ -26,7 +26,7 @@ export declare const addClassName: (otherAttrs: {
 }) => void;
 /**
  * Converts the given tag attributes object to a string
- * @param {Object.<string, unknown>} attributes the attributes object
+ * @param {{[key: string]: unknown}} attributes the attributes object
  * @returns {string} string representation of the attributes
  */
 export declare const getAttributesString: (attributes: {