@sitecore-jss/sitecore-jss-nextjs 22.2.0-canary.9 → 22.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.2.0-canary.9",
+  "version": "22.2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -29,7 +29,8 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
-    "@sitecore-cloudsdk/personalize": "^0.3.1",
+    "@sitecore-cloudsdk/core": "^0.4.0",
+    "@sitecore-cloudsdk/personalize": "^0.4.0",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-string": "^1.4.2",
@@ -54,7 +55,7 @@
     "eslint-plugin-react": "^7.32.1",
     "jsdom": "^21.1.0",
     "mocha": "^10.2.0",
-    "next": "^14.1.0",
+    "next": "^14.2.7",
     "nock": "^13.3.0",
     "nyc": "^15.1.0",
     "react": "^18.2.0",
@@ -65,16 +66,16 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
-    "@sitecore-cloudsdk/events": "^0.3.1",
-    "@sitecore-cloudsdk/personalize": "^0.3.1",
-    "next": "^14.1.0",
+    "@sitecore-cloudsdk/core": "^0.4.0",
+    "@sitecore-cloudsdk/personalize": "^0.4.0",
+    "next": "^14.2.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.2.0-canary.9",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^22.2.0-canary.9",
-    "@sitecore-jss/sitecore-jss-react": "^22.2.0-canary.9",
+    "@sitecore-jss/sitecore-jss": "22.2.0",
+    "@sitecore-jss/sitecore-jss-dev-tools": "22.2.0",
+    "@sitecore-jss/sitecore-jss-react": "22.2.0",
     "@vercel/kv": "^0.2.1",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -82,7 +83,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "843696778d1ce2cb8cb4d0ff21bf60da5df3020e",
+  "gitHead": "628c78c44857670879a1ade67f58c61d516425e9",
   "files": [
     "dist",
     "types",

package/types/editing/editing-render-middleware.d.ts

@@ -1,6 +1,7 @@
 import { NextApiRequest, NextApiResponse } from 'next';
 import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
 import { EditMode, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
+import { LayoutKind } from '@sitecore-jss/sitecore-jss/editing';
 import { EditingDataService } from './editing-data-service';
 import { RenderMiddlewareBase } from './render-middleware';
 /**
@@ -108,6 +109,7 @@ export type MetadataQueryParams = {
     mode: Exclude<LayoutServicePageState, 'normal'>;
     sc_variant?: string;
     sc_version?: string;
+    sc_layoutKind?: LayoutKind;
 };
 /**
  * Next.js API request with Metadata query parameters.
@@ -126,6 +128,7 @@ export type EditingMetadataPreviewData = {
     pageState: Exclude<LayoutServicePageState, 'Normal'>;
     variantIds: string[];
     version?: string;
+    layoutKind?: LayoutKind;
 };
 /**
  * Type guard for EditingMetadataPreviewData

package/types/index.d.ts

@@ -1,4 +1,4 @@
-export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
+export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, CacheClient, CacheOptions, MemoryCacheClient, } 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, getContentStylesheetLink, EditMode, } 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';
@@ -22,5 +22,4 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 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, 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';

package/types/middleware/index.d.ts

@@ -1,4 +1,5 @@
 export { debug } from '@sitecore-jss/sitecore-jss';
+export { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
 export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
 export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
 export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';

package/types/middleware/redirects-middleware.d.ts

@@ -1,5 +1,5 @@
-import { NextResponse, NextRequest } from 'next/server';
 import { GraphQLRedirectsServiceConfig } from '@sitecore-jss/sitecore-jss/site';
+import { NextRequest, NextResponse } from 'next/server';
 import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
 /**
  * extended RedirectsMiddlewareConfig config type for RedirectsMiddleware
@@ -37,4 +37,32 @@ export declare class RedirectsMiddleware extends MiddlewareBase {
      * @private
      */
     private getExistsRedirect;
+    /**
+     * When a user clicks on a link generated by the Link component from next/link,
+     * Next.js adds special parameters in the route called path.
+     * This method removes these special parameters.
+     * @param {NextURL} url
+     * @returns {string} normalize url
+     */
+    private normalizeUrl;
+    /**
+     * Helper function to create a redirect response and remove the x-middleware-next header.
+     * @param {NextURL} url The URL to redirect to.
+     * @param {Response} res The response object.
+     * @param {number} status The HTTP status code of the redirect.
+     * @param {string} statusText The status text of the redirect.
+     * @returns {NextResponse<unknown>} The redirect response.
+     */
+    private createRedirectResponse;
+    /**
+     * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
+     * It constructs all possible query parameter permutations and tests them against the pattern.
+     * @param {Object} params - The parameters for the URL match.
+     * @param {string} params.pathname - The current URL pathname.
+     * @param {string} params.queryString - The current URL query string.
+     * @param {string} params.pattern - The regex pattern to test the constructed URLs against.
+     * @param {string} [params.locale] - The locale prefix to include in the URL if present.
+     * @returns {string | undefined} - return query string if any of the query permutations match the provided pattern, undefined otherwise.
+     */
+    private isPermutedQueryMatch;
 }

package/context.d.ts

@@ -1 +0,0 @@
-export * from './types/context/index';

package/context.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/context/index');

package/dist/cjs/context/context.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
-const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
-/**
- * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
- */
-class Context {
-    constructor(props) {
-        this.props = props;
-        /**
-         * Indicates whether the Context and SDK(s) have been initialized
-         */
-        this.isInitialized = false;
-        /**
-         * Software Development Kits (SDKs) to be initialized
-         */
-        this.sdks = {};
-        /**
-         * Promises for the SDKs
-         */
-        this.sdkPromises = {};
-        this.sdkErrors = {};
-        /**
-         * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
-         *
-         * @param {string} name SDK name
-         * @returns initialized SDK
-         */
-        this.getSDK = (name) => {
-            if (!this.sdkPromises[name]) {
-                return Promise.reject(`Unknown SDK '${String(name)}'`);
-            }
-            else {
-                return this.sdkPromises[name].then((result) => {
-                    return ((this.sdkErrors[name] && Promise.reject(this.sdkErrors[name])) || Promise.resolve(result));
-                });
-            }
-        };
-        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
-        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
-        this.siteName = props.siteName;
-        this.pageState = sitecore_jss_react_1.LayoutServicePageState.Normal;
-    }
-    init(props = {}) {
-        // Context and SDKs are initialized only once
-        if (this.isInitialized)
-            return;
-        this.isInitialized = true;
-        if (props.siteName) {
-            this.siteName = props.siteName;
-        }
-        if (props.pageState) {
-            this.pageState = props.pageState;
-        }
-        // iterate over the SDKs and initialize them
-        for (const sdkName of Object.keys(this.props.sdks)) {
-            this.initSDK(sdkName);
-        }
-    }
-    /**
-     * Initializes the Software Development Kit (SDK)
-     *
-     * @param {T} name SDK name
-     * @returns {void}
-     */
-    initSDK(name) {
-        this.sdkPromises[name] = new Promise((resolve) => {
-            this.props.sdks[name]
-                .init(this)
-                .then(() => {
-                this.sdks[name] = this.props.sdks[name].sdk;
-                resolve(this.sdks[name]);
-            })
-                .catch((e) => {
-                // if init rejects, we mark SDK as failed - so getSDK call would reject with a reason
-                this.sdkErrors[name] = e;
-                resolve(undefined);
-            });
-        });
-    }
-}
-exports.Context = Context;

package/dist/cjs/context/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
-var context_1 = require("./context");
-Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });

package/dist/esm/context/context.js

@@ -1,79 +0,0 @@
-import { LayoutServicePageState } from '@sitecore-jss/sitecore-jss-react';
-/**
- * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
- */
-export class Context {
-    constructor(props) {
-        this.props = props;
-        /**
-         * Indicates whether the Context and SDK(s) have been initialized
-         */
-        this.isInitialized = false;
-        /**
-         * Software Development Kits (SDKs) to be initialized
-         */
-        this.sdks = {};
-        /**
-         * Promises for the SDKs
-         */
-        this.sdkPromises = {};
-        this.sdkErrors = {};
-        /**
-         * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
-         *
-         * @param {string} name SDK name
-         * @returns initialized SDK
-         */
-        this.getSDK = (name) => {
-            if (!this.sdkPromises[name]) {
-                return Promise.reject(`Unknown SDK '${String(name)}'`);
-            }
-            else {
-                return this.sdkPromises[name].then((result) => {
-                    return ((this.sdkErrors[name] && Promise.reject(this.sdkErrors[name])) || Promise.resolve(result));
-                });
-            }
-        };
-        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
-        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
-        this.siteName = props.siteName;
-        this.pageState = LayoutServicePageState.Normal;
-    }
-    init(props = {}) {
-        // Context and SDKs are initialized only once
-        if (this.isInitialized)
-            return;
-        this.isInitialized = true;
-        if (props.siteName) {
-            this.siteName = props.siteName;
-        }
-        if (props.pageState) {
-            this.pageState = props.pageState;
-        }
-        // iterate over the SDKs and initialize them
-        for (const sdkName of Object.keys(this.props.sdks)) {
-            this.initSDK(sdkName);
-        }
-    }
-    /**
-     * Initializes the Software Development Kit (SDK)
-     *
-     * @param {T} name SDK name
-     * @returns {void}
-     */
-    initSDK(name) {
-        this.sdkPromises[name] = new Promise((resolve) => {
-            this.props.sdks[name]
-                .init(this)
-                .then(() => {
-                this.sdks[name] = this.props.sdks[name].sdk;
-                resolve(this.sdks[name]);
-            })
-                .catch((e) => {
-                // if init rejects, we mark SDK as failed - so getSDK call would reject with a reason
-                this.sdkErrors[name] = e;
-                resolve(undefined);
-            });
-        });
-    }
-}

package/dist/esm/context/index.js

@@ -1 +0,0 @@
-export { Context } from './context';

package/types/context/context.d.ts

@@ -1,116 +0,0 @@
-import { LayoutServicePageState } from '@sitecore-jss/sitecore-jss-react';
-/**
- * Software Development Kit (SDK) instance
- */
-export type SDK<SDKType = unknown> = {
-    /**
-     * The Software Development Kit (SDK) library instance
-     */
-    sdk: SDKType;
-    /**
-     * Initializes the Software Development Kit (SDK)
-     */
-    init: (props: InitSDKProps) => Promise<void>;
-};
-/**
- * Software Development Kits (SDKs) to be initialized
- */
-type SDKModulesType = Record<string, SDK>;
-/**
- * Properties that are passed to the Context.
- */
-export interface ContextInitProps {
-    /**
-     * Your Sitecore site name
-     */
-    siteName?: string;
-    /**
-     * Sitecore page state (normal, preview, edit)
-     */
-    pageState?: LayoutServicePageState;
-}
-/**
- * Configuration that is passed to the Context.
- */
-export interface ContextConfig<SDKModules extends SDKModulesType> {
-    /**
-     * Your Sitecore Edge URL
-     */
-    sitecoreEdgeUrl: string;
-    /**
-     * Your Sitecore Edge Context ID
-     */
-    sitecoreEdgeContextId: string;
-    /**
-     * Your Sitecore site name
-     */
-    siteName: string;
-    /**
-     * Software Development Kits (SDKs) to be initialized
-     */
-    sdks: {
-        [module in keyof SDKModules]: SDKModules[module];
-    };
-}
-/**
- * Properties that are passed to the Software Development Kit (SDK) initialization function.
- */
-type InitSDKProps = Omit<ContextConfig<SDKModulesType>, 'sdks'>;
-/**
- * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
- */
-export declare class Context<SDKModules extends SDKModulesType> {
-    protected props: ContextConfig<SDKModules>;
-    /**
-     * Indicates whether the Context and SDK(s) have been initialized
-     */
-    isInitialized: boolean;
-    /**
-     * The Sitecore Edge URL
-     */
-    readonly sitecoreEdgeUrl: string;
-    /**
-     * The Sitecore Edge Context ID
-     */
-    readonly sitecoreEdgeContextId: string;
-    /**
-     * The Sitecore site name
-     */
-    siteName: string;
-    /**
-     * Sitecore page state (normal, preview, edit)
-     */
-    pageState: LayoutServicePageState;
-    /**
-     * Software Development Kits (SDKs) to be initialized
-     */
-    readonly sdks: {
-        [module in keyof SDKModules]?: SDKModules[module]['sdk'];
-    };
-    /**
-     * Promises for the SDKs
-     */
-    protected sdkPromises: {
-        [module in keyof SDKModules]?: Promise<SDKModules[module]['sdk']>;
-    };
-    protected sdkErrors: {
-        [module in keyof SDKModules]?: string;
-    };
-    constructor(props: ContextConfig<SDKModules>);
-    init(props?: ContextInitProps): void;
-    /**
-     * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
-     *
-     * @param {string} name SDK name
-     * @returns initialized SDK
-     */
-    getSDK: <T extends keyof SDKModules>(name: T) => Promise<SDKModules[T]["sdk"]>;
-    /**
-     * Initializes the Software Development Kit (SDK)
-     *
-     * @param {T} name SDK name
-     * @returns {void}
-     */
-    protected initSDK<T extends keyof SDKModules>(name: T): void;
-}
-export {};

package/types/context/index.d.ts

@@ -1 +0,0 @@
-export { Context, ContextConfig, SDK } from './context';