@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.38 → 22.0.0-canary.42

package/dist/esm/middleware/redirects-middleware.js

@@ -12,7 +12,8 @@ import { NextResponse } from 'next/server';
 import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { MiddlewareBase } from './middleware';
-const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'gi');
+const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
+const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
 /**
  * Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
  * compares with current url and redirects to target url
@@ -29,13 +30,14 @@ export class RedirectsMiddleware extends MiddlewareBase {
             const language = this.getLanguage(req);
             const hostname = this.getHostHeader(req) || this.defaultHostname;
             let site;
+            const startTimestamp = Date.now();
             debug.redirects('redirects middleware start: %o', {
                 pathname,
                 language,
                 hostname,
             });
             const createResponse = () => __awaiter(this, void 0, void 0, function* () {
-                if (this.config.disabled && this.config.disabled(req, NextResponse.next())) {
+                if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
                     debug.redirects('skipped (redirects middleware is disabled)');
                     return res || NextResponse.next();
                 }
@@ -51,44 +53,58 @@ export class RedirectsMiddleware extends MiddlewareBase {
                     return res || NextResponse.next();
                 }
                 // Find context site language and replace token
-                if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target)) {
+                if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
+                    !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
+                        existsRedirect.target.includes(hostname))) {
                     existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
                 }
                 const url = req.nextUrl.clone();
-                const absoluteUrlRegex = new RegExp('^(?:[a-z]+:)?//', 'i');
-                if (absoluteUrlRegex.test(existsRedirect.target)) {
+                if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
                     url.href = existsRedirect.target;
-                    url.locale = req.nextUrl.locale;
                 }
                 else {
+                    const source = `${url.pathname}${url.search}`;
                     url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
                     const urlFirstPart = existsRedirect.target.split('/')[1];
                     if (this.locales.includes(urlFirstPart)) {
                         url.locale = urlFirstPart;
-                        url.pathname = existsRedirect.target.replace(`/${urlFirstPart}`, '');
+                        existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
                     }
-                    else {
-                        url.pathname = existsRedirect.target;
+                    const target = source
+                        .replace(regexParser(existsRedirect.pattern), existsRedirect.target)
+                        .replace(/^\/\//, '/')
+                        .split('?');
+                    url.pathname = target[0];
+                    if (target[1]) {
+                        const newParams = new URLSearchParams(target[1]);
+                        for (const [key, val] of newParams.entries()) {
+                            url.searchParams.append(key, val);
+                        }
                     }
                 }
                 const redirectUrl = decodeURIComponent(url.href);
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
                     case REDIRECT_TYPE_301:
-                        return NextResponse.redirect(redirectUrl, 301);
+                        return NextResponse.redirect(redirectUrl, {
+                            status: 301,
+                            statusText: 'Moved Permanently',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case REDIRECT_TYPE_302:
-                        return NextResponse.redirect(redirectUrl, 302);
+                        return NextResponse.redirect(redirectUrl, {
+                            status: 302,
+                            statusText: 'Found',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case REDIRECT_TYPE_SERVER_TRANSFER:
-                        return NextResponse.rewrite(redirectUrl);
+                        return NextResponse.rewrite(redirectUrl, res);
                     default:
-                        return NextResponse.next();
+                        return res || NextResponse.next();
                 }
             });
             const response = yield createResponse();
-            // Share site name with the following executed middlewares
-            // Don't need to set when middleware is disabled
-            site && response.cookies.set(this.SITE_SYMBOL, site.name);
-            debug.redirects('redirects middleware end: %o', {
+            debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
                 redirected: response.redirected,
                 status: response.status,
                 url: response.url,
@@ -128,15 +144,22 @@ export class RedirectsMiddleware extends MiddlewareBase {
         return __awaiter(this, void 0, void 0, function* () {
             const redirects = yield this.redirectsService.fetchRedirects(siteName);
             const tragetURL = req.nextUrl.pathname;
-            const targetQS = `?${req.nextUrl.search || ''}`;
-            return redirects.length
-                ? redirects.find((redirect) => {
-                    const pattern = `/^/${redirect.pattern
+            const targetQS = req.nextUrl.search || '';
+            const language = this.getLanguage(req);
+            const modifyRedirects = structuredClone(redirects);
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
+                    redirect.pattern = `/^\/${redirect.pattern
                         .replace(/^\/|\/$/g, '')
-                        .replace(/^\^|\$$/g, '')}$/gi`;
-                    return ((regexParser(pattern).test(tragetURL) ||
-                        regexParser(pattern).test(`${tragetURL}${targetQS}`) ||
-                        regexParser(pattern).test(`/${req.nextUrl.locale}${tragetURL}`.toLowerCase())) &&
+                        .replace(/^\^\/|\/\$$/g, '')
+                        .replace(/^\^|\$$/g, '')
+                        .replace(/(?<!\\)\?/g, '\\?')
+                        .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
+                    return ((regexParser(redirect.pattern).test(tragetURL) ||
+                        regexParser(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
+                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
+                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}${targetQS}`)) &&
                         (redirect.locale
                             ? redirect.locale.toLowerCase() === req.nextUrl.locale.toLowerCase()
                             : true));

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 */
@@ -32,7 +31,7 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
   $language: String!
   $includedPaths: [String]
   $excludedPaths: [String]
-  $pageSize: Int = 10
+  $pageSize: Int = 100
   $after: String
 ) {
   site {
@@ -128,7 +127,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 +135,7 @@ export class BaseGraphQLSitemapService {
                 const results = yield this.fetchLanguageSitePaths(language, siteName);
                 const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language);
                 paths.push(...transformedPaths);
-            })));
+            }
             return paths;
         });
     }
@@ -191,8 +190,10 @@ export class BaseGraphQLSitemapService {
      * @returns {GraphQLClient} implementation
      */
     getGraphQLClient() {
-        return new GraphQLRequestClient(this.options.endpoint, {
-            apiKey: this.options.apiKey,
+        if (!this.options.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
+        }
+        return this.options.clientFactory({
             debugger: debug.sitemap,
         });
     }

package/dist/esm/services/component-props-service.js

@@ -17,9 +17,9 @@ export class ComponentPropsService {
      */
     fetchServerSideComponentProps(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { componentModule, layoutData, context } = params;
+            const { moduleFactory, layoutData, context } = params;
             const fetchFunctionFactory = (componentName) => __awaiter(this, void 0, void 0, function* () {
-                const module = yield componentModule(componentName);
+                const module = yield moduleFactory(componentName);
                 return module === null || module === void 0 ? void 0 : module.getServerSideProps;
             });
             return this.fetchComponentProps(fetchFunctionFactory, layoutData, context);
@@ -33,9 +33,9 @@ export class ComponentPropsService {
      */
     fetchStaticComponentProps(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { componentModule, layoutData, context } = params;
+            const { moduleFactory, layoutData, context } = params;
             const fetchFunctionFactory = (componentName) => __awaiter(this, void 0, void 0, function* () {
-                const module = yield componentModule(componentName);
+                const module = yield moduleFactory(componentName);
                 return module === null || module === void 0 ? void 0 : module.getStaticProps;
             });
             return this.fetchComponentProps(fetchFunctionFactory, layoutData, context);
@@ -122,11 +122,11 @@ export class ComponentPropsService {
                     componentProps[uid] = result;
                 })
                     .catch((error) => {
-                    const errLog = `Error during preload data for component ${uid}: ${error.message ||
-                        error}`;
+                    const errLog = `Error during preload data for component ${req.rendering.componentName} (${uid}): ${error.message || error}`;
                     console.error(chalk.red(errLog));
                     componentProps[uid] = {
                         error: error.message || errLog,
+                        componentName: req.rendering.componentName,
                     };
                 });
             });

package/dist/esm/utils/utils.js

@@ -1,4 +1,3 @@
-import chalk from 'chalk';
 import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/utils';
 /**
  * Get the publicUrl.
@@ -6,25 +5,20 @@ import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/u
  * This is set to http://localhost:3000 by default.
  * VERCEL_URL is provided by Vercel in case if we are in Preview deployment (deployment based on the custom branch),
  * preview deployment has unique url, we don't know exact url.
+ * Similarly, DEPLOY_URL is provided by Netlify and would give us the deploy URL
+ * In production non-editing environments it is desirable to use relative urls, so in that case set PUBLIC_URL = ''
  */
 export const getPublicUrl = () => {
-    if (process.env.VERCEL_URL)
-        return `https://${process.env.VERCEL_URL}`;
     let url = process.env.PUBLIC_URL;
     if (url === undefined) {
-        console.warn(`${chalk.yellow.bold('Warning:')} An PUBLIC_URL environment variable is not defined. Falling back to http://localhost:3000.`);
+        if (process.env.NETLIFY && process.env.DEPLOY_URL)
+            return process.env.DEPLOY_URL;
+        if (process.env.VERCEL_URL)
+            return `https://${process.env.VERCEL_URL}`;
         url = 'http://localhost:3000';
     }
-    else {
-        try {
-            new URL(url);
-        }
-        catch (error) {
-            throw new Error(`The PUBLIC_URL environment variable '${url}' is not a valid URL.`);
-        }
-    }
     // Ensure no trailing slash
-    return url.toString().replace(/\/$/, '');
+    return url.replace(/\/$/, '');
 };
 /**
  * Since Sitecore editors do not support Fast Refresh:

package/graphql.d.ts

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

package/graphql.js

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

package/package.json

@@ -1,21 +1,20 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.0.0-canary.38",
+  "version": "22.0.0-canary.42",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
   "scripts": {
     "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
     "clean": "del-cli dist types",
-    "lint": "eslint ./src/**/*.tsx ./src/**/*.ts",
+    "lint": "eslint \"./src/**/*.tsx\" \"./src/**/*.ts\"",
     "test": "mocha --require ./test/setup.js \"./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-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
   },
   "engines": {
-    "node": ">=12",
-    "npm": ">=6"
+    "node": ">=18"
   },
   "author": {
     "name": "Sitecore Corporation",
@@ -30,6 +29,7 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
+    "@sitecore-cloudsdk/personalize": "^0.3.0",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-string": "^1.4.2",
@@ -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": "^14.1.0",
     "nock": "^13.3.0",
     "nyc": "^15.1.0",
     "react": "^18.2.0",
@@ -65,14 +65,17 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
-    "next": "^13.1.6",
+    "@sitecore-cloudsdk/events": "^0.3.0",
+    "@sitecore-cloudsdk/personalize": "^0.3.0",
+    "next": "^14.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.0.0-canary.38",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^22.0.0-canary.38",
-    "@sitecore-jss/sitecore-jss-react": "^22.0.0-canary.38",
+    "@sitecore-jss/sitecore-jss": "^22.0.0-canary.42",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^22.0.0-canary.42",
+    "@sitecore-jss/sitecore-jss-react": "^22.0.0-canary.42",
+    "@vercel/kv": "^0.2.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -80,7 +83,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "7fd4d56d0513e9a2e0d516f92de3e77cb7457fe3",
+  "gitHead": "5832a186100a80805113d68cde0f8e578ef9193c",
   "files": [
     "dist",
     "types",

package/types/ComponentBuilder.d.ts

@@ -0,0 +1,61 @@
+/// <reference types="@types/react" />
+import { ComponentFactory } from '@sitecore-jss/sitecore-jss-react';
+import { Module, ModuleFactory } from './sharedTypes/module-factory';
+import { ComponentType } from 'react';
+/**
+ * Represents a component that can be imported dynamically
+ */
+export type LazyModule = {
+    module: () => Promise<Module>;
+    element: (isEditing?: boolean) => ComponentType;
+};
+/**
+ * Component is a module or a lazy module
+ */
+type Component = Module | LazyModule | ComponentType;
+/**
+ * Configuration for ComponentBuilder
+ */
+export type ComponentBuilderConfig<Component> = {
+    /**
+     * List of components to be stored
+     */
+    components: Map<string, Component>;
+};
+/**
+ * Configuration for ComponentFactory
+ */
+type ComponentFactoryConfig = {
+    isEditing?: boolean;
+};
+/**
+ * Nextjs implementation of component builder class for building components based on the configuration.
+ */
+export declare class ComponentBuilder {
+    protected config: ComponentBuilderConfig<Component>;
+    /**
+     * List of components to be stored
+     */
+    protected components: Map<string, Component>;
+    /**
+     * SXA uses custom default export name
+     */
+    protected DEFAULT_EXPORT_NAME: string;
+    constructor(config: ComponentBuilderConfig<Component>);
+    /**
+     * Creates a new instance of module factory
+     * Module factory provides a module (file) including all exports.
+     * Module can be imported dynamically or statically.
+     * @returns {ModuleFactory} Module factory implementation
+     */
+    getModuleFactory(): ModuleFactory;
+    /**
+     * Creates a new instance of component factory
+     * Component can be imported dynamically or statically.
+     * @param {Object} [config] Component factory configuration
+     * @param {boolean} [config.isEditing] Indicates if component factory is used in editing mode
+     * @returns {ComponentFactory} Component factory implementation
+     */
+    getComponentFactory({ isEditing }?: ComponentFactoryConfig): ComponentFactory;
+}
+export {};

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/ComponentPropsContext.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@types/react" />
 import React, { ReactNode } from 'react';
 import { ComponentPropsCollection } from '../sharedTypes/component-props';
 /**

package/types/components/FEaaSWrapper.d.ts

@@ -0,0 +1,21 @@
+import { FEaaSWrapper } from '@sitecore-jss/sitecore-jss-react';
+import { GetStaticComponentProps, GetServerSideComponentProps } from '../sharedTypes/component-props';
+/**
+ * This is a repackaged version of the React FEaaSWrapper 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
+ * @param {LayoutServiceData} layoutData
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getStaticProps: GetStaticComponentProps;
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @param {LayoutServiceData} layoutData
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getServerSideProps: GetServerSideComponentProps;
+export default FEaaSWrapper;

package/types/components/Link.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@types/react" />
 import React from 'react';
 import { LinkProps as ReactLinkProps } from '@sitecore-jss/sitecore-jss-react';
 export type LinkProps = ReactLinkProps & {
@@ -7,4 +8,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/NextImage.d.ts

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

package/types/components/Placeholder.d.ts

@@ -1,2 +1,4 @@
+/// <reference types="@types/react" />
+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/components/RichText.d.ts

@@ -6,6 +6,12 @@ export type RichTextProps = ReactRichTextProps & {
      * @default 'a[href^="/"]'
      */
     internalLinksSelector?: string;
+    /**
+     * Controls the prefetch of internal links. This can be beneficial if you have RichText fields
+     * with large numbers of internal links in them.
+     * @default true
+     */
+    prefetchLinks?: boolean;
 };
 export declare const RichText: {
     (props: RichTextProps): JSX.Element;

package/types/context/context.d.ts

@@ -0,0 +1,116 @@
+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

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

package/types/editing/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const QUERY_PARAM_EDITING_SECRET = "secret";
+export declare const QUERY_PARAM_PROTECTION_BYPASS_SITECORE = "x-sitecore-protection-bypass";
+export declare const QUERY_PARAM_PROTECTION_BYPASS_VERCEL = "x-vercel-protection-bypass";

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

@@ -0,0 +1,29 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+import { Metadata } from '@sitecore-jss/sitecore-jss-dev-tools';
+export type EditingConfigMiddlewareConfig = {
+    /**
+     * Components available in the application
+     */
+    components: string[] | Map<string, unknown>;
+    /**
+     * Application metadata
+     */
+    metadata: Metadata;
+};
+/**
+ * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
+ * provides configuration information to determine feature compatibility on Pages side.
+ */
+export declare class EditingConfigMiddleware {
+    protected config: EditingConfigMiddlewareConfig;
+    /**
+     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
+     */
+    constructor(config: EditingConfigMiddlewareConfig);
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}