@sitecore-jss/sitecore-jss-nextjs 21.4.0-canary.1 → 21.4.0-canary.11

package/README.md

@@ -2,11 +2,8 @@
 
 This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.
 
-<!---
-@TODO: Update to next version docs before release
--->
 [Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/21/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
 
 [Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
 
-[API reference documentation](/ref-docs/sitecore-jss-nextjs/)
+[API reference documentation](/ref-docs/sitecore-jss-nextjs/)

package/dist/cjs/components/BYOCWrapper.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServerSideProps = exports.getStaticProps = void 0;
+const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
+const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
+/**
+ * This is a repackaged version of the React BYOCWrapper component with support for
+ * server rendering in Next.js (using component-level data-fetching feature of JSS).
+ */
+/**
+ * Will be called during SSG
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+const getStaticProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === sitecore_jss_1.constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield (0, sitecore_jss_react_1.fetchBYOCComponentServerProps)(params);
+    return result;
+});
+exports.getStaticProps = getStaticProps;
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+const getServerSideProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === sitecore_jss_1.constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield (0, sitecore_jss_react_1.fetchBYOCComponentServerProps)(params);
+    return result;
+});
+exports.getServerSideProps = getServerSideProps;
+exports.default = sitecore_jss_react_1.BYOCWrapper;

package/dist/cjs/index.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 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.GraphQLRequestClient = 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.debug = exports.enableDebug = exports.NativeDataFetcher = exports.AxiosDataFetcher = exports.constants = void 0;
-exports.withDatasourceCheck = exports.withPlaceholder = exports.withEditorChromes = exports.useSitecoreContext = exports.withSitecoreContext = exports.SitecoreContextReactContext = exports.SitecoreContext = exports.VisitorIdentification = exports.File = exports.BYOCWrapper = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.ComponentBuilder = exports.FEaaSWrapper = void 0;
+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;
 var sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 Object.defineProperty(exports, "constants", { enumerable: true, get: function () { return sitecore_jss_1.constants; } });
 Object.defineProperty(exports, "AxiosDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.AxiosDataFetcher; } });
@@ -108,6 +108,8 @@ var NextImage_1 = require("./components/NextImage");
 Object.defineProperty(exports, "NextImage", { enumerable: true, get: function () { return NextImage_1.NextImage; } });
 const FEaaSWrapper = __importStar(require("./components/FEaaSWrapper"));
 exports.FEaaSWrapper = FEaaSWrapper;
+const BYOCWrapper = __importStar(require("./components/BYOCWrapper"));
+exports.BYOCWrapper = BYOCWrapper;
 var ComponentBuilder_1 = require("./ComponentBuilder");
 Object.defineProperty(exports, "ComponentBuilder", { enumerable: true, get: function () { return ComponentBuilder_1.ComponentBuilder; } });
 var sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
@@ -119,7 +121,6 @@ Object.defineProperty(exports, "FEaaSComponent", { enumerable: true, get: functi
 Object.defineProperty(exports, "fetchFEaaSComponentServerProps", { enumerable: true, get: function () { return sitecore_jss_react_1.fetchFEaaSComponentServerProps; } });
 Object.defineProperty(exports, "BYOCComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCComponent; } });
 Object.defineProperty(exports, "getFEAASLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getFEAASLibraryStylesheetLinks; } });
-Object.defineProperty(exports, "BYOCWrapper", { enumerable: true, get: function () { return sitecore_jss_react_1.BYOCWrapper; } });
 Object.defineProperty(exports, "File", { enumerable: true, get: function () { return sitecore_jss_react_1.File; } });
 Object.defineProperty(exports, "VisitorIdentification", { enumerable: true, get: function () { return sitecore_jss_react_1.VisitorIdentification; } });
 Object.defineProperty(exports, "SitecoreContext", { enumerable: true, get: function () { return sitecore_jss_react_1.SitecoreContext; } });

package/dist/cjs/services/base-graphql-sitemap-service.js

@@ -36,7 +36,7 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
   $language: String!
   $includedPaths: [String]
   $excludedPaths: [String]
-  $pageSize: Int = 10
+  $pageSize: Int = 100
   $after: String
 ) {
   site {
@@ -132,7 +132,7 @@ class BaseGraphQLSitemapService {
     getTranformedPaths(siteName, languages, formatStaticPath) {
         return __awaiter(this, void 0, void 0, function* () {
             const paths = new Array();
-            yield Promise.all(languages.map((language) => __awaiter(this, void 0, void 0, function* () {
+            for (const language of languages) {
                 if (language === '') {
                     throw new RangeError(languageEmptyError);
                 }
@@ -140,7 +140,7 @@ class BaseGraphQLSitemapService {
                 const results = yield this.fetchLanguageSitePaths(language, siteName);
                 const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language);
                 paths.push(...transformedPaths);
-            })));
+            }
             return paths;
         });
     }

package/dist/esm/components/BYOCWrapper.js

@@ -0,0 +1,42 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { BYOCWrapper, fetchBYOCComponentServerProps, } from '@sitecore-jss/sitecore-jss-react';
+import { constants } from '@sitecore-jss/sitecore-jss';
+/**
+ * This is a repackaged version of the React BYOCWrapper component with support for
+ * server rendering in Next.js (using component-level data-fetching feature of JSS).
+ */
+/**
+ * Will be called during SSG
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export const getStaticProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield fetchBYOCComponentServerProps(params);
+    return result;
+});
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export const getServerSideProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield fetchBYOCComponentServerProps(params);
+    return result;
+});
+export default BYOCWrapper;

package/dist/esm/index.js

@@ -32,6 +32,8 @@ export { Placeholder } from './components/Placeholder';
 export { EditingComponentPlaceholder } from './components/EditingComponentPlaceholder';
 export { NextImage } from './components/NextImage';
 import * as FEaaSWrapper from './components/FEaaSWrapper';
+import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
+export { BYOCWrapper };
 export { ComponentBuilder } from './ComponentBuilder';
-export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, BYOCWrapper, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
+export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';

package/dist/esm/services/base-graphql-sitemap-service.js

@@ -32,7 +32,7 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
   $language: String!
   $includedPaths: [String]
   $excludedPaths: [String]
-  $pageSize: Int = 10
+  $pageSize: Int = 100
   $after: String
 ) {
   site {
@@ -128,7 +128,7 @@ export class BaseGraphQLSitemapService {
     getTranformedPaths(siteName, languages, formatStaticPath) {
         return __awaiter(this, void 0, void 0, function* () {
             const paths = new Array();
-            yield Promise.all(languages.map((language) => __awaiter(this, void 0, void 0, function* () {
+            for (const language of languages) {
                 if (language === '') {
                     throw new RangeError(languageEmptyError);
                 }
@@ -136,7 +136,7 @@ export class BaseGraphQLSitemapService {
                 const results = yield this.fetchLanguageSitePaths(language, siteName);
                 const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language);
                 paths.push(...transformedPaths);
-            })));
+            }
             return paths;
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "21.4.0-canary.1",
+  "version": "21.4.0-canary.11",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -37,7 +37,7 @@
     "@types/mocha": "^10.0.1",
     "@types/node": "~18.11.18",
     "@types/prop-types": "^15.7.5",
-    "@types/react": "^18.0.27",
+    "@types/react": "^18.2.22",
     "@types/react-dom": "^18.0.10",
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.9",
@@ -54,7 +54,7 @@
     "eslint-plugin-react": "^7.32.1",
     "jsdom": "^21.1.0",
     "mocha": "^10.2.0",
-    "next": "^13.1.6",
+    "next": "^13.4.16",
     "nock": "^13.3.0",
     "nyc": "^15.1.0",
     "react": "^18.2.0",
@@ -65,14 +65,14 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
-    "next": "^13.1.6",
+    "next": "^13.4.16",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.4.0-canary.1",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^21.4.0-canary.1",
-    "@sitecore-jss/sitecore-jss-react": "^21.4.0-canary.1",
+    "@sitecore-jss/sitecore-jss": "^21.4.0-canary.11",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^21.4.0-canary.11",
+    "@sitecore-jss/sitecore-jss-react": "^21.4.0-canary.11",
     "@vercel/kv": "^0.2.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
@@ -81,7 +81,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "ba19b0377facf496ea5f5cbe31f724fa3fb26ebf",
+  "gitHead": "1b0eeeb98dbe3e9dbb139cf28719572987bd83c8",
   "files": [
     "dist",
     "types",

package/types/components/BYOCWrapper.d.ts

@@ -0,0 +1,19 @@
+import { BYOCWrapper } from '@sitecore-jss/sitecore-jss-react';
+import { GetStaticComponentProps, GetServerSideComponentProps } from '../sharedTypes/component-props';
+/**
+ * This is a repackaged version of the React BYOCWrapper component with support for
+ * server rendering in Next.js (using component-level data-fetching feature of JSS).
+ */
+/**
+ * Will be called during SSG
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getStaticProps: GetStaticComponentProps;
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getServerSideProps: GetServerSideComponentProps;
+export default BYOCWrapper;

package/types/components/Link.d.ts

@@ -7,4 +7,4 @@ export type LinkProps = ReactLinkProps & {
      */
     internalLinkMatcher?: RegExp;
 };
-export declare const Link: React.ForwardRefExoticComponent<Pick<LinkProps, "key" | keyof React.AnchorHTMLAttributes<HTMLAnchorElement> | "field" | "editable" | "showLinkTextWithChildrenPresent" | "internalLinkMatcher"> & React.RefAttributes<HTMLAnchorElement>>;
+export declare const Link: React.ForwardRefExoticComponent<Omit<LinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;

package/types/components/Placeholder.d.ts

@@ -1,2 +1,3 @@
+import React from 'react';
 import { PlaceholderComponentProps } from '@sitecore-jss/sitecore-jss-react';
-export declare const Placeholder: (props: PlaceholderComponentProps) => JSX.Element;
+export declare const Placeholder: (props: PlaceholderComponentProps) => React.JSX.Element;

package/types/index.d.ts

@@ -25,6 +25,8 @@ export { Placeholder } from './components/Placeholder';
 export { EditingComponentPlaceholder } from './components/EditingComponentPlaceholder';
 export { NextImage } from './components/NextImage';
 import * as FEaaSWrapper from './components/FEaaSWrapper';
+import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
+export { BYOCWrapper };
 export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
-export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getFEAASLibraryStylesheetLinks, BYOCWrapper, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';
+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';

package/types/services/base-graphql-sitemap-service.d.ts

@@ -30,7 +30,7 @@ interface SiteRouteQueryVariables {
     /** common variable for all GraphQL queries
      * it will be used for every type of query to regulate result batch size
      * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
-     * @default 10
+     * @default 100
      */
     pageSize?: number;
 }