1. Sitecore JavaScript Services SDKs (JSS) 22.x

Upgrade JSS 22.6 Next.js apps to version 22.7

Version:

This guide covers most of the changes you must make to your existing Next.js JSS 22.6 applications to take advantage of the improvements in version 22.7. However, because this process also involves updating React to version 19 and Next.js to version 15, you'll need to refer to the relevant guides for each framework to complete the upgrade process for your apps.

Important

An important change introduced in version 22.7 for Next.js is the removal of automatic code generation for GraphQL. The previous third-party package used for this (graphql-let) is no longer being maintained and causes potential security vulnerabilities. This upgrade guide explains how to disable graphql-let, and we strongly recommend you do so, especially if you have no need for automatic code generation.

You can still manually implement code generation logic if you want it. This documentation includes a guide to doing so using graphql-codegen as an alternative package.

Because of the nature of JavaScript and Next.js application development, this guide doesn't account for all the customization you might have in your existing application.

While upgrading, consider the JSS templates and add-ons you used when creating your Next.js application. You can find them in your package.json file. For example, a JSS 22.6 application included in the XM Cloud starter foundation uses the following templates and add-ons:

  • nextjs 

  • nextjs-xmcloud 

  • nextjs-sxa 

  • nextjs-multisite 

XM Cloud is now SitecoreAI

Some code examples, images, and UI labels may still use XM Cloud while engineering assets are being updated.

Before you begin

  • If you haven't already done so, upgrade your app to JSS 22.6.

  • We recommend you read the official release notes for React 19 and Next.js 15 to understand what has changed in these new versions.

  • Familiarize yourself with the changelog. If your application is heavily customized, the changelog can provide guidance on what additional changes you need that are not covered in this topic.

This topic describes how to:

  1. Update application dependencies in your existing app

  2. Create a JSS 22.7 Next.js application

  3. Update the Next.js template files in your existing app

  4. Update the SXA add-on

  5. Disable automatic GraphQL code generation

Update application dependencies in your existing app

For your upgraded application to work correctly, you will need to update dependencies.

To update your dependencies:

  1. In your existing application's package.json file:

    • Update every @sitecore-jss package to version ~22.7.0.

    • Update every @sitecore-cloudsdk package to version ^0.5.1.

    • Update the following dependencies to the specified versions:

      "next": "^15.3.1",
"react": "^19.1.0",
"react-dom": "^19.1.0",
"@types/react": "^19.1.2",
"@types/react-dom": "^19.1.3",
"eslint-plugin-react": "^7.37.5",

  2. Install the dependencies with the following command:

    npm install

Create a JSS 22.7 Next.js application

To simplify the upgrade process as much as possible, create a JSS 22.7 Next.js application with the XM Cloud add-on. You can then copy some files from this app into your existing app.

To create a JSS 22.7 Next.js application with the XM Cloud add-on included:

  1. In a console, run the following command:

  2. If prompted to install the [email protected] package, answer y.

  3. Enter the folder path for the JSS 22.7 Next.js app. For example, enter ./jss227, to create the app folder in your current working directory.

  4. Follow the remaining prompts, selecting the same options for data fetching (GraphQL or REST) and prerendering (SSG or SSR) as in your existing application.

  5. When asked if you are building for Sitecore XM Cloud, answer y to install the XM Cloud add-on.

  6. Select other add-ons used by your existing application and press Enter.

The script then installs the application dependencies.

XM Cloud is now SitecoreAI

Some code examples, images, and UI labels may still use XM Cloud while engineering assets are being updated.

Update the Next.js template files in your existing app

This explains how to synchronize files in your existing application with corresponding files from your new JSS 22.7 app.

To update the Next.js template files:

  1. For every component that uses the JSX namespace (for example, if a JSX.Element type is present), add a JSX import from react.

    • In the src/Bootstrap.tsx file, the existing react import might look like this:

      import { useEffect } from 'react';

    • In which case, add JSX to create the following:

      import { useEffect, JSX } from 'react';
    Tip

    If you haven't previously customized these files, you can replace them with the versions from your template app.

  2. Because Next.js 15 removes the geo and ip properties from NextRequest, if your solution is hosted by Vercel you need to update your src/lib/middleware/plugins/personalize.ts plugin to explicitly provide geo data to the PersonalizeMiddleware, via the PersonalizeOptions parameter of the personalize middleware handler.

    If you have not customized the src/lib/middleware/plugins/personalize.ts file, replace it with the version in your template app. Otherwise, modify it as shown in the following example:

    import { NextRequest, NextResponse } from 'next/server';
import { geolocation } from '@vercel/functions'
import { PersonalizeMiddleware } from '@sitecore-jss/sitecore-jss-nextjs/middleware';
import { MiddlewarePlugin } from '..';
...

class PersonalizePlugin implements MiddlewarePlugin {
  private personalizeMiddleware: PersonalizeMiddleware;

  ...

  async exec(req: NextRequest, res?: NextResponse): Promise<NextResponse> {
    const { city, country, region } = geolocation(req)

    return this.personalizeMiddleware.getHandler()(req, res, {
      geo: { city, country, region },
    });
  }
}

export const personalizePlugin = new PersonalizePlugin();

Update the SXA add-on

To update the SXA add-on:

  1. If you have not customized the src/assets/sass/components/_component-column-splitter.scss file, replace it with the version in your template app. Otherwise, do the following:

    • Locate the following padding rules:

      padding-left: $default-padding / 2;
padding-right: $default-padding / 2;

    • Replace those rules with the following:

      padding-left: $default-padding * 0.5;
padding-right: $default-padding * 0.5;

  2. If you have not customized the /src/assets/sass/components/promo/_promo-shadow.scss file, replace it with the version in your template app. Otherwise, reposition the CSS statements above the @include respond-to(all-mobile) block, as shown in the following example:

    • CSS statements previously:

      ...
  >.component-content {
    @include respond-to(all-mobile) {
      margin: 0 10px 30px 10px;
    }
    padding: 15px;
    margin: 0 0 30px 0;
    &:before, &:after {
      ...

    • CSS statements afterwards:

      ...
  >.component-content {
    padding: 15px;
    margin: 0 0 30px 0;
    @include respond-to(all-mobile) {
      margin: 0 10px 30px 10px;
    }
    &:before, &:after {
      ...

  3. If you have not customized the src/lib/next-config/plugins/sass.js file, replace it with the version in your template app. Otherwise, add the following extra properties to your sassOptions configuration:

    sassOptions: {
  ...
  quietDeps: true,
  silenceDeprecations: ["import", "legacy-js-api"],
},
    Note

    This change is a temporary fix to suppress sass deprecation warnings from Bootstrap. When new versions of bootstrap and font-awesome are released and the warnings stop, these two properties can be removed.

Disable automatic GraphQL code generation

This section explains how to remove your app's default, automatic code generation logic based on the no-longer-maintained graphql-let package. We strongly recommended that you do this unless you have a specific need to continue using graphql-let. If you would prefer to manually implement code generation using graphql-codegen, follow the guide to learn how.

Important

As with all upgrade steps, before you make any of the changes in this section, be aware of how they might affect customizations made to your own app. These instructions include removal of graphql-codegen dependencies, which you might decide to keep if you plan to implement manual code generation.

To disable automatic GraphQL code generation:

  1. In your existing application's package.json file:

    • Delete the following dependencies:

      "@graphql-typed-document-node/core": "^3.2.0",
"graphql-let": "^0.18.6",

    • If you don't plan to use graphql-codegen to manually implement code generation, also delete the following dependencies:

      "graphql": "~15.8.0",
"graphql-tag": "^2.12.6",
"@graphql-codegen/cli": "^5.0.0",
"@graphql-codegen/import-types-preset": "^3.0.0",
"@graphql-codegen/plugin-helpers": "^5.0.1",
"@graphql-codegen/typed-document-node": "^5.0.1",
"@graphql-codegen/typescript": "^4.0.1",
"@graphql-codegen/typescript-operations": "^4.0.1",
"@graphql-codegen/typescript-resolvers": "^4.0.1",

    • Unless you want to use the following script for fetching of GraphQL introspection data, for example as part of a manual implementation of GraphQL code generation, delete it:

      "graphql:update": "ts-node --project tsconfig.scripts.json ./scripts/fetch-graphql-introspection-data.ts",

    • If your bootstrap script references graphql-let, remove that reference. The following example shows a valid bootstrap script with the graphql-let call removed:

      "bootstrap": "ts-node --require dotenv-flow/config --project tsconfig.scripts.json scripts/bootstrap.ts",
    Note

    After making these changes, re-run npm install to update your app's dependencies.

  2. Delete the following files associated with graphql-let:

    • .graphql-let.yml

    • /scripts/fetch-graphql-introspection-data.ts

    • /src/temp/GraphQLIntrospectionResult.json

  3. If you have not customized the tsconfig.json file, replace it with the version in your template app. Otherwise, delete the following item from compilerOptions.paths:

    "graphql-types": ["node_modules/@types/graphql-let/__generated__/__types__"],

Next steps

To finalize the upgrade process, make sure you resolve any errors and warnings you encounter. Enable debug logging for JSS specific issues to assist you if necessary.

If you have suggestions for improving this article, let us know!