[nextjs][content] Support time-based preview in editing render endpoint by sc-shakyawijerathne · Pull Request #524 · Sitecore/content-sdk

sc-shakyawijerathne · 2026-06-18T12:17:15Z

This PR follows the Contribution Guide
Changelog updated
Upgrade guide entry added

Description / Motivation

This PR adds support for calendar-based preview in the JSS editing render endpoint. The editing middleware now accepts an optional sc_previewTime query parameter and forwards it as a header to Edge Preview GraphQL.

This enables XM Cloud Pages users to preview content at specific future dates, allowing validation of scheduled content changes before they go live.

Testing Details

Unit Test Added
Manual Test/Other (Please elaborate)

Unit Tests:

Test that sc_previewTime query param is forwarded as header
Test backward compatibility when sc_previewTime is absent

Manual Testing:

Verified local editing render endpoint accepts sc_previewTime parameter
Confirmed header is correctly forwarded to GraphQL requests

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

…middleware

changeset-bot · 2026-06-18T12:17:20Z

🦋 Changeset detected

Latest commit: 0ef3b03

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@sitecore-content-sdk/nextjs	Patch
@sitecore-content-sdk/content	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2026-06-18T12:26:48Z

📦 Package Size and Test Coverage Report

Package	Base Size	PR Size	Δ Change	Base Coverage	PR Coverage	Δ Change
analytics-core	67.34 KB	67.34 KB	✅ 0.00 KB	97.40%	97.40%	0.00%
cli	61.06 KB	61.06 KB	✅ 0.00 KB	71.36%	71.36%	0.00%
content	432.56 KB	432.99 KB	🔺 +0.43 KB	92.45%	92.46%	+0.01%
core	120.61 KB	120.61 KB	✅ 0.00 KB	91.27%	91.27%	0.00%
create-content-sdk-app	535.58 KB	535.58 KB	✅ 0.00 KB	96.47%	96.47%	0.00%
events	72.27 KB	72.27 KB	✅ 0.00 KB	97.97%	97.97%	0.00%
nextjs	566.34 KB	566.30 KB	🔻 -0.04 KB	90.98%	90.99%	+0.00%
personalize	64.01 KB	64.01 KB	✅ 0.00 KB	99.74%	99.74%	0.00%
react	232.23 KB	232.23 KB	✅ 0.00 KB	94.00%	94.00%	0.00%
search	8.10 KB	8.10 KB	✅ 0.00 KB	98.57%	98.57%	0.00%
Total	—	—	🔺 +0.39 KB	—	—	—

illiakovalenko

Looks good 👍
Please, see a couple of comments below

illiakovalenko · 2026-06-19T08:05:07Z

        [EDITING_PARAMS_HEADER]: JSON.stringify(previewData),
      };
+
+      if (query.sc_previewTime) {


We have mapEditingParams method, you can map this parameter there

illiakovalenko · 2026-06-19T08:08:21Z

  sc_layoutKind?: LayoutKind;
  sc_variant?: string;
  sc_version?: string;
+  sc_previewTime?: string;


The new parameter needs to be passed to EditingService.fetchEditingData, so that it is included in the layout request.

It should be set as a sc_previewTime header

illiakovalenko · 2026-06-19T08:10:48Z

        [EDITING_PARAMS_HEADER]: JSON.stringify(previewData),
      };
+
+      if (query.sc_previewTime) {


Also, keep in mind that we have editing-render-route-handler - App Router. You, probably, shouldn't need to make any additional changes there, as updating the mapEditingParams method should apply this automatically. Probably only unit tests

…nterfaces for enhanced preview functionality

…Preview method

illiakovalenko · 2026-06-19T10:52:46Z

        dataSourceId: query.dataSourceId,
        version: query.sc_version,
        generation: query.generation,
+        ...(query.sc_previewTime && { previewTime: query.sc_previewTime }),


In design studio we don't expect to pass it, so let's remove it. We need to support it only for Sitecore Pages

illiakovalenko · 2026-06-19T10:54:14Z

        mode,
        site,
        variantId,
+        ...(previewTime && { previewTime }),


Can we simplify it a bit?

Suggested change

...(previewTime && { previewTime }),

previewTime,

illiakovalenko · 2026-06-19T10:54:56Z

Let's add unit tests to cover new parameter

illiakovalenko · 2026-06-19T10:55:40Z

Let's update unit tests

…nt, EditingService, and utility functions

…/github.com/Sitecore/content-sdk into feature/JSS-9801-support-time-based-preview

…PreviewData interface

…Data interface

illiakovalenko

Looks great! 👍

sc-shakyawijerathne added 2 commits June 18, 2026 17:39

feat: Add support for sc_previewTime in EditingRenderQueryParams and …

51d70a2

…middleware

Add changeset

e5ae9b5

sc-shakyawijerathne requested a review from illiakovalenko June 18, 2026 12:27

illiakovalenko requested changes Jun 19, 2026

View reviewed changes

sc-shakyawijerathne added 2 commits June 19, 2026 15:33

feat: Introduce previewTime parameter in EditingOptions and related i…

fc3eeb1

…nterfaces for enhanced preview functionality

test: Add unit tests for previewTime handling in SitecoreClient's get…

9ed5a2e

…Preview method

sc-shakyawijerathne requested a review from illiakovalenko June 19, 2026 10:31

Merge branch 'dev' into feature/JSS-9801-support-time-based-preview

0bd1e89

illiakovalenko requested changes Jun 19, 2026

View reviewed changes

sc-shakyawijerathne added 3 commits June 19, 2026 17:09

test: Enhance unit tests for previewTime handling across SitecoreClie…

a24292b

…nt, EditingService, and utility functions

Merge branch 'feature/JSS-9801-support-time-based-preview' of https:/…

3508cdb

…/github.com/Sitecore/content-sdk into feature/JSS-9801-support-time-based-preview

refactor: Remove unused previewTime property from DesignLibraryRender…

5dff7bd

…PreviewData interface

sc-shakyawijerathne requested review from illiakovalenko and removed request for illiakovalenko June 19, 2026 11:52

refactor: Remove previewTime property from DesignLibraryRenderPreview…

0ef3b03

…Data interface

sc-shakyawijerathne requested a review from illiakovalenko June 19, 2026 12:18

illiakovalenko approved these changes Jun 19, 2026

View reviewed changes

Comment thread packages/nextjs/src/editing/utils.ts

illiakovalenko force-pushed the feature/JSS-9801-support-time-based-preview branch from 9ebc7bd to 0ef3b03 Compare June 19, 2026 13:20

illiakovalenko merged commit 7b3b3f3 into dev Jun 19, 2026
7 checks passed

illiakovalenko deleted the feature/JSS-9801-support-time-based-preview branch June 19, 2026 13:28

Conversation

sc-shakyawijerathne commented Jun 18, 2026

Description / Motivation

Testing Details

Types of changes

Uh oh!

changeset-bot Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Package Size and Test Coverage Report

Uh oh!

illiakovalenko left a comment

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

illiakovalenko Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

illiakovalenko left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot Bot commented Jun 18, 2026 •

edited

Loading

github-actions Bot commented Jun 18, 2026 •

edited

Loading

illiakovalenko Jun 19, 2026 •

edited

Loading