@sitecore-jss/sitecore-jss-nextjs 21.8.0-canary.8 → 21.8.0-canary.9

package/README.md

@@ -5,7 +5,7 @@ This module is provided as a part of Sitecore JavaScript Rendering SDK. It conta
 <!---
 @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 (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/22/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)
 

package/dist/cjs/index.js

@@ -23,41 +23,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.getContentStylesheetLink = 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.ClientError = 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.getComponentLibraryStylesheetLinks = exports.getFEAASLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = exports.DateField = exports.Text = exports.Image = exports.Context = exports.ComponentBuilder = exports.BYOCWrapper = exports.FEaaSWrapper = exports.NextImage = void 0;
+exports.DateField = exports.Text = exports.Image = exports.Context = exports.ComponentBuilder = exports.BYOCWrapper = 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.getContentStylesheetLink = exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.getFieldValue = exports.getChildPlaceholder = exports.RestLayoutService = exports.GraphQLLayoutService = exports.LayoutServicePageState = 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.getComponentLibraryStylesheetLinks = exports.BYOCComponent = exports.fetchFEaaSComponentServerProps = exports.FEaaSComponent = exports.EditFrame = 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; } });
-/** @deprecated use import 'GraphQLClientError' from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
-Object.defineProperty(exports, "ClientError", { enumerable: true, get: function () { return sitecore_jss_1.ClientError; } });
 Object.defineProperty(exports, "NativeDataFetcher", { enumerable: true, get: function () { return sitecore_jss_1.NativeDataFetcher; } });
 Object.defineProperty(exports, "enableDebug", { enumerable: true, get: function () { return sitecore_jss_1.enableDebug; } });
 Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return sitecore_jss_1.debug; } });
-// we will remove the root exports for these later
-// we cannot mark exports as deprected directly, so we're using this hack instead
-const graphql_1 = require("./graphql");
-const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
-const utils_2 = require("./utils");
-/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
-const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChromes, resolveUrlDep: resolveUrl, tryParseEnvValueDep: tryParseEnvValue, handleEditorFastRefreshDep: handleEditorFastRefresh, getPublicUrlDep: getPublicUrl, } = {
-    isEditorActiveDep: utils_1.isEditorActive,
-    resetEditorChromesDep: utils_1.resetEditorChromes,
-    resolveUrlDep: utils_1.resolveUrl,
-    tryParseEnvValueDep: utils_1.tryParseEnvValue,
-    handleEditorFastRefreshDep: utils_2.handleEditorFastRefresh,
-    getPublicUrlDep: utils_2.getPublicUrl,
-};
-exports.isEditorActive = isEditorActive;
-exports.resetEditorChromes = resetEditorChromes;
-exports.resolveUrl = resolveUrl;
-exports.tryParseEnvValue = tryParseEnvValue;
-exports.handleEditorFastRefresh = handleEditorFastRefresh;
-exports.getPublicUrl = getPublicUrl;
-/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
-const { GraphQLRequestClientDep: GraphQLRequestClient } = {
-    GraphQLRequestClientDep: graphql_1.GraphQLRequestClient,
-};
-exports.GraphQLRequestClient = GraphQLRequestClient;
 var layout_1 = require("@sitecore-jss/sitecore-jss/layout");
 Object.defineProperty(exports, "LayoutServicePageState", { enumerable: true, get: function () { return layout_1.LayoutServicePageState; } });
 Object.defineProperty(exports, "GraphQLLayoutService", { enumerable: true, get: function () { return layout_1.GraphQLLayoutService; } });
@@ -128,7 +101,6 @@ Object.defineProperty(exports, "EditFrame", { enumerable: true, get: function ()
 Object.defineProperty(exports, "FEaaSComponent", { enumerable: true, get: function () { return sitecore_jss_react_1.FEaaSComponent; } });
 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, "getComponentLibraryStylesheetLinks", { enumerable: true, get: function () { return sitecore_jss_react_1.getComponentLibraryStylesheetLinks; } });
 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; } });

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

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseGraphQLSitemapService = exports.getSiteEmptyError = exports.siteError = exports.languageError = void 0;
-const graphql_1 = require("@sitecore-jss/sitecore-jss/graphql");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const personalize_1 = require("@sitecore-jss/sitecore-jss/personalize");
 /** @private */
@@ -195,16 +194,10 @@ class BaseGraphQLSitemapService {
      * @returns {GraphQLClient} implementation
      */
     getGraphQLClient() {
-        if (!this.options.endpoint) {
-            if (!this.options.clientFactory) {
-                throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
-            }
-            return this.options.clientFactory({
-                debugger: sitecore_jss_1.debug.sitemap,
-            });
+        if (!this.options.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
         }
-        return new graphql_1.GraphQLRequestClient(this.options.endpoint, {
-            apiKey: this.options.apiKey,
+        return this.options.clientFactory({
             debugger: sitecore_jss_1.debug.sitemap,
         });
     }

package/dist/esm/index.js

@@ -1,27 +1,4 @@
-export { constants, AxiosDataFetcher, 
-/** @deprecated use import 'GraphQLClientError' from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
-ClientError, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
-// we will remove the root exports for these later
-// we cannot mark exports as deprected directly, so we're using this hack instead
-import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
-import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
-import { handleEditorFastRefresh as handleEditorFastRefreshDep, getPublicUrl as getPublicUrlDep, } from './utils';
-/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
-const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChromes, resolveUrlDep: resolveUrl, tryParseEnvValueDep: tryParseEnvValue, handleEditorFastRefreshDep: handleEditorFastRefresh, getPublicUrlDep: getPublicUrl, } = {
-    isEditorActiveDep,
-    resetEditorChromesDep,
-    resolveUrlDep,
-    tryParseEnvValueDep,
-    handleEditorFastRefreshDep,
-    getPublicUrlDep,
-};
-/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
-const { GraphQLRequestClientDep: GraphQLRequestClient } = {
-    GraphQLRequestClientDep,
-};
-export { GraphQLRequestClient };
-export { handleEditorFastRefresh, getPublicUrl };
-export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
+export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
 export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, getContentStylesheetLink, } from '@sitecore-jss/sitecore-jss/layout';
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
@@ -44,4 +21,4 @@ export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder } from './ComponentBuilder';
 export { Context } from './context';
-export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, getComponentLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
+export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';

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

@@ -7,7 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { GraphQLRequestClient, } from '@sitecore-jss/sitecore-jss/graphql';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { getPersonalizedRewrite } from '@sitecore-jss/sitecore-jss/personalize';
 /** @private */
@@ -191,16 +190,10 @@ export class BaseGraphQLSitemapService {
      * @returns {GraphQLClient} implementation
      */
     getGraphQLClient() {
-        if (!this.options.endpoint) {
-            if (!this.options.clientFactory) {
-                throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
-            }
-            return this.options.clientFactory({
-                debugger: debug.sitemap,
-            });
+        if (!this.options.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
         }
-        return new GraphQLRequestClient(this.options.endpoint, {
-            apiKey: this.options.apiKey,
+        return this.options.clientFactory({
             debugger: debug.sitemap,
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "21.8.0-canary.8",
+  "version": "21.8.0-canary.9",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -72,9 +72,9 @@
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.8.0-canary.8",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^21.8.0-canary.8",
-    "@sitecore-jss/sitecore-jss-react": "^21.8.0-canary.8",
+    "@sitecore-jss/sitecore-jss": "^21.8.0-canary.9",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^21.8.0-canary.9",
+    "@sitecore-jss/sitecore-jss-react": "^21.8.0-canary.9",
     "@vercel/kv": "^0.2.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
@@ -83,7 +83,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "44610f837682c5746b34c21e523eeb35f20d8a4e",
+  "gitHead": "0d84c70a90eb3a0e411da3b48e321df400653a1a",
   "files": [
     "dist",
     "types",

package/types/components/NextImage.d.ts

@@ -2,6 +2,6 @@
 import React from 'react';
 import { ImageProps } from '@sitecore-jss/sitecore-jss-react';
 import { ImageProps as NextImageProperties } from 'next/image';
-type NextImageProps = Omit<ImageProps, 'media'> & Partial<NextImageProperties>;
+type NextImageProps = ImageProps & Partial<NextImageProperties>;
 export declare const NextImage: React.FC<NextImageProps>;
 export {};

package/types/index.d.ts

@@ -1,15 +1,4 @@
-export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, 
-/** @deprecated use import 'GraphQLClientError' from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
-ClientError, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
-import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
-import { resolveUrl as resolveUrlDep } from '@sitecore-jss/sitecore-jss/utils';
-/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
-declare const isEditorActive: () => boolean, resetEditorChromes: () => void, resolveUrl: typeof resolveUrlDep, tryParseEnvValue: <T>(envValue: string | undefined, defaultValue: T) => T, handleEditorFastRefresh: (forceReload?: boolean) => void, getPublicUrl: () => string;
-/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
-declare const GraphQLRequestClient: typeof GraphQLRequestClientDep;
-export { GraphQLRequestClient };
-export { handleEditorFastRefresh, getPublicUrl };
-export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
+export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
 export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, RestLayoutService, RestLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, getContentStylesheetLink, } from '@sitecore-jss/sitecore-jss/layout';
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
@@ -35,4 +24,4 @@ export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
 export { Context, ContextConfig, SDK } from './context';
-export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getFEAASLibraryStylesheetLinks, getComponentLibraryStylesheetLinks, 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, getComponentLibraryStylesheetLinks, 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

@@ -66,16 +66,6 @@ export type RouteListQueryResult = {
  * Configuration options for @see GraphQLSitemapService instances
  */
 export interface BaseGraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariables, 'language' | 'siteName'> {
-    /**
-     * Your Graphql endpoint
-     * @deprecated use @param clientFactory property instead
-     */
-    endpoint?: string;
-    /**
-     * The API key to use for authentication.
-     * @deprecated use @param clientFactory property instead
-     */
-    apiKey?: string;
     /**
      * A flag for whether to include personalized routes in service output - only works on XM Cloud
      * turned off by default
@@ -85,7 +75,7 @@ export interface BaseGraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVari
      * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
      * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
      */
-    clientFactory?: GraphQLRequestClientFactory;
+    clientFactory: GraphQLRequestClientFactory;
 }
 /**
  * Object model of a site page item.