Skip to content

Latest commit

 

History

History
585 lines (437 loc) · 46.5 KB

CHANGELOG.md

File metadata and controls

585 lines (437 loc) · 46.5 KB

Changelog

All notable changes to this project will be documented in this file. The format (starting with 18.0.0) is based on Keep a Changelog.

This project does NOT adhere to Semantic Versioning, and major versions of this project denote compatibility with Sitecore Platform versions. Refer to the "Headless Services" section in the Sitecore modules compatibility table or the Headless Rendering download page for more details on versioning.

Unreleased

New Features & Improvements

[sitecore-jss-*] Consolidated tightly coupled packages together and refactored the sitecore base package into submodules. (#824)

[samples/angular] Language is now preserved when navigating to another page (#793)

[samples/nextjs][samples/react][samples/vue][samples/angular][sitecore-jss-cli] Prefix added to templates which is replaced on jss create (#800, #811, #813, #814, #816)

19.0.0

New Features & Improvements

[sitecore-jss-react] [sitecore-jss-nextjs] Add withDatasourceCheck higher order component (HOC) to better handle renderings with missing datasources (#723)

[sitecore-jss-*] Compile and publish all base package as ESM (#758)

[sitecore-jss] [sitecore-jss-nextjs] [Dictionary Service] [Sitemap Service] Provide ability to customize jssAppTemplateId (#763)

[sitecore-jss] Update editing functions for Horizon compatibility (backwards compatible) (#712)

[sitecore-jss-nextjs]

  • Upgrade to Next.js 11 (#768)
  • Utilize the VERCEL_URL env variable (if available) for generating public URLs (#725)
  • Enable dynamic component import (#727)
  • Prevent extraneous router.replace in Experience Editor when using SSG (#736)

[sitecore-jss-vue]

  • Upgrade version 2.x to 3.x (#724)
  • Use fragments by default with sc-placeholder (#742)

[samples/nextjs] [samples/react] [samples/angular] [samples/vue]

  • Remove usage of deprecated dataApi. Replaced by RestLayoutService and RestDictionaryService (#744)
  • More reliable detection of disconnected or connected mode (#732)

[samples/react] [samples/angular] [samples/vue] (#773)

  • Add support for the --fetchWith option for jss create, which selects REST or GraphQL APIs
  • Update to use Edge schema for GraphQL by default
  • Update Sitecore configuration patches with relevant Edge-specific definitions

[samples/nextjs]

  • Upgrade to Next.js 11 (#768)
  • Horizon editor compatibility (#712, #723, #752)
  • Enable creating a new app without boilerplate with the --empty flag for jss create (#754)
  • Enable dynamic component import in sample (#727, #730)

[samples/vue] Upgrade version 2.x to 3.x. Simplify dependencies; remove dependency on i18n (#724)

[samples/embedded-app] Remove dependency on StepZilla (#747)

[samples/node-headless-ssr-proxy] Remove '/dist' path from pathRewriteExcludeRoutes (#756)

Bug Fixes

[sitecore-jss-react] [samples/nextjs] [samples/react] Fix double rendering (#775)

[sitecore-jss-react] Error rendering raw self-closing tag elements in placeholders (#745)

[sitecore-jss-react-forms] Experience Forms JSS React implementation doesn't use CSS class applied to entire form (#771)

[samples/angular] Fix issue where dk-DA language is not rendered in connected and disconnected mode (#734)

[samples/react] Fix 504 (Gateway Timeout) errors for proxied Sitecore requests (visitor identification, media, etc) when running in connected mode (#808)

Breaking Changes

[sitecore-jss] [sitecore-jss-vue] [sitecore-jss-react-native] [sitecore-jss-react] [sitecore-jss-nextjs] [sitecore-jss-angular] Remove deprecated dataApi (#744)

[sitecore-jss-*] [samples/*] Avoid use of 'any' for TypeScript definitions (#759)

18.0.0

New Features

All JSS services have been upgraded to support Sitecore Experience Edge GraphQL schema.

[sitecore-jss]

[sitecore-jss-nextjs]

[samples/nextjs]

  • Update Sitecore configuration patches with relevant Edge-specific definitions.
  • The sample uses Edge schema by default.
  • #695 Add settings for language fallback with Experience Edge.
  • #696 Add IncludeServerUrlInMediaUrls "default" configuration to avoid exposing the Sitecore server publicly when using Experience Edge.

[samples/react] [samples/angular] [samples/vue] The samples can also utilize Sitecore Experience Edge. A new sample [samples/node-headless-ssr-experience-edge] has been adeded to demonstrate how to configure this. Read docs.

New & Improved Service Classes

[sitecore-jss]

  • GraphQLDictionaryService is a new service for fetching dictionary data using GraphQL Read docs.
  • GraphQLLayoutService is a new service for fetching layout data using GraphQL Read docs.
  • #716 Allow overriding which "named" Layout Service configuration (from Sitecore config) is used by JSS.
  • Allow overriding 3rd party dependencies in JSS services that depend on 3rd party functionality (GraphQLLayoutService, RestDictionaryService, GraphQLDictionaryService, GraphQLSitemapService).

[sitecore-jss-nextjs]

  • Make GraphQLSitemapService easier to customize by allowing overrides of default options. (#682, #705)

Other Notable Improvements

  • [sitecore-jss] Enable debug logging for JSS services using the debug module. Read docs.
  • New options in jss create command. Read docs.

[samples/react-native] (#624)

  • Add shared <Layout/> component in order to have shared navigation panel.
  • Make Sitecore logo in header is touchable and will navigate to Home page when click on it.
  • Remove usage of dataConversation.

Bug Fixes

[sitecore-jss]

  • Fix issue with dictionary phrases not being cached when caching is enabled (#639)
  • mediaApi.updateImageUrl now only switches to JSS media handler prefix if imageParams are sent. Otherwise, the original media URL is returned. Fixes hash errors ("ERROR MediaRequestProtection: An invalid/missing hash value was encountered.") from appearing in Sitecore logs (#681)

[samples/nextjs] [samples/react] [samples/vue]

  • Fix issue where using the jss scaffold generated files with inconsistent line endings (#684)
  • Update Text components to accept number values (#713)

[sitecore-jss-nextjs]

  • Fix issue with getStaticPathsonly pre-rendering the first 10 pages (638)
  • Fix issue where links inside RichText controls caused pages to load twice (659)

[sitecore-jss-react] Render value instead of array of single value when value doesn't contain line breaks (714)

[sitecore-jss-react-native] (#624)

  • [Image] Pass Object style type for SvgUrI instead of Array.
  • [Date] Always render <HtmlView/> if editable is provided.

[samples/react-native] (#624)

  • Fix Styleguide-FieldUsage-Date not working in connected mode.
  • Styleguide-FieldUsage-Image: Fix incorrect src prop type in disconnected mode. Fix 'Plain image' example in connected mode. Remove unsupported 'Srcset image' adaptive example.
  • Styleguide-ComponentParams: fix incorrect params prop types in connected mode.
  • Fix connected tunnel mode for secure (https) Sitecore endpoints.

[samples/node-headless-ssr-proxy] Fix how header value for 'accept-encoding' is set. This resolves an issue in the Angular sample where the /graphql page caused a console error (#680)

[sitecore-jss-forms] Fix issue where pre-filled (default) form data isn't removed for multi-valued fields when user de-selects values (#677)

Breaking Changes

[sitecore-jss-react-native] Removed dataConversation, since editable property not used in disconnected mode. (#624)

[samples/angular] Upgrade angular to v11. (#635)

[samples/nextjs] Change how a custom query can be used in GraphQLSitemapService. Previous way: pass a formatSearchQuery function to fetchExportSitemap or fetchSSGSitemap. New way: extend the GraphQLSitemapService class and override the fetchSitemap method. (#638)

  • As part of adding support for Experience Edge, Sitecore XM's graphQL API was updated to mirror Experience Edge's schema. The following updates in JSS
    • [sitecore-jss-nextjs] Update sitemap query to comply with changes to the GraphQL API
    • [samples/nextjs] Update generated TypeScript models for GraphQL components to comply with changes to the GraphQL API

With the added support of GraphQL endpoints, the API surface area of JSS has essentially doubled. As a result, some reorganizing was done in the base packages, which causes breaking changes for how some services, classes and functions are exported. If you have imports from JSS base packages in your project, they may need to be updated per the migration guide table.

Sitecore JSS 16.0 for Sitecore 10.1

Upgrading

There are migration instructions from JSS 15-based applications.

Breaking changes

  • PR #485 [JSS CLI] Add --config argument to specify the path to scjssconfig.json file. resolveScJssConfig now accepts arguments as an object instead of using individual arguments.
  • PR #460 [sitecore-jss-react] Fix return type of ComponentFactory to allow a component definition instead of an instantiated component. ComponentFactory returns ComponentType | null instead of Component.
  • PR #459 [sitecore-jss-react] Change propType of missingComponentComponent from React.SFC (deprecated) to React.FC.
  • PR #538 [sitecore-jss-react] Change propType of errorComponent from React.SFC (deprecated) to React.FC.
  • PR #517 [packages/samples] Migrate TSLint (deprecated) to ESLint.

New Features & Improvements

  • Documentation Add support for Next.js framework. 🎉🎉🎉
  • Commit [sitecore-jss] Add RestDictionaryService to fetch dictionary data using the Sitecore Dictionary Service REST API, and RestLayoutService to fetch layout data using the Sitecore Layout Service REST API.
  • PR #511 [sitecore-jss] Add AxiosDataFetcher to provide a default data fetcher implementation which can be used in sample apps.
  • PR #530 [sitecore-jss] Add GraphQLRequestClient to provide the ability to execute GraphQL queries.
  • PR #525 [sitecore-jss-react] Enable SitecoreContext to support TypeScript generics.
  • PR #508 [sitecore-jss-react] Add the useSitecoreContext hook.
  • PR #542 Add environment variable support via an .env file to the CLI.

Bug Fixes

  • PR #548 [sitecore-jss-dev-tools] jss deploy doesn't exit on success.
  • PR #541 [sitecore-jss-dev-tools][sitecore-jss-cli] Replace old and security vulnerable request and axios NPM packages with latest version of axios (>=0.21.1).
  • PR #506 [React sample] Cannot read property 'sitecore' of null, when 404 and routeData is null.
  • PR #575 [sitecore-jss-react] Specifying a custom error component via the Placeholder's errorComponent prop caused an "Invalid prop" error.
  • PR #477 [sitecore-jss-proxy] Prevent passing 'qs' as 'undefined' in rewriteRequestPath.
  • PR #459 [sitecore-jss-react] Fix propType of missingComponentComponent, resolving an issue with custom "Missing Component" components not working.
  • PR #538 [sitecore-jss-react] Fix propType of errorComponent, resolving an issue with custom "Error" components not working.
  • PR #521 [packages/samples] Upgrade react, react-dom.

Sitecore JSS 15.0.1

Bug Fixes

  • PR #487 [sitecore-jss-proxy][#CS0195052] changes to HEAD request handling
  • PR #486 [sitecore-jss][mediaApi] Prevent editing of original query/params
  • PR #483 [sitecore-jss-manifest] Process media field with single item recursively
  • PR #484 [sitecore-jss-angular] Fix ngcc.config.js incorrect structure

Sitecore JSS 15.0 for Sitecore 10

Upgrading

There are migration instructions from JSS 14-based applications.

Breaking changes

  • PR #414, PR #456 React:

    • SitecoreContextFactory class was removed. Subscribers were removed, so context value now stored in SitecoreContext state.
    • SitecoreContext accepts context value instead of contextFactory SitecoreContextFactory instance.

  • PR #440 [Angular sample] Upgrade angular to v10

New Features & Improvements

  • PR #466 [sitecore-embedded-jss-app] Remove usage of SitecoreContextFactory
  • PR #463 [React][Vue][Angular] Use keep-alive agent throughout sample apps for server-side web requests
  • PR #430 [node-headless-proxy] Connection pooling to layout service
  • PR #429 [node-headless-proxy] Output caching
  • PR #386 [Forms] Assign contextItemId in Forms submit actions on a JSS Forms submit
  • PR #390 [sitecore-jss-react] Replace line breaks with <br/> in the <Text> component
  • PR #407 [React sample] enable eslint
  • PR #413 [All samples] Add yaml-lint
  • PR #419 [sitecore-jss-angular][sitecore-jss-react][sitecore-jss-vue] Provide ability to configure mediaUrlPrefix in mediaApi using <Image /> component

Bug Fixes

  • PR #478 [sitecore-jss] Merge specific params from layout service into query string
  • Issue #326 [Angular sample] en.yml changes in Angular JSS app giving error: Duplicate function implementation
  • PR #471 [node-headless-proxy] Upgrade lodash, node-fetch libraries
  • PR #461 [node-headless-proxy] Remove use of onProxyReq event in sample proxy options
  • Issue #452 [sitecore-jss-angular] ngcc config not correctly implemented
  • PR #464 [Security] Review and resolve security vulnerabilities
  • PR #456 [React sample] Race condition, under load React app may render HTML from a different route
  • Issue #428 imageParams on Image react component don't play nice with allowedMediaParams
  • PR #448 [node-headless-proxy] Extend headers handling and remove content-security-policy header
  • PR #444 [Vue sample] Fix i18n memory leak
  • PR #414 [sitecore-jss-react] Memory leak in SitecoreContext
  • Commit [Forms] Number Forms field has incorrect model and step attribute
  • Issue #140 [sitecore-jss-proxy] query string values aren't transferred properly
  • PR #391 [Angular sample] Component factory match first occurrence of Component name
  • PR #379 [sitecore-jss-angular] Prevent existing anchor element classes from being wiped out by the link directive
  • PR #395 [React sample] Retrieving language from ssrInitialState is incorrect
  • PR #400 [sitecore-jss-proxy] Percentage symbol in query string breaks in SSR
  • PR #401 [React sample] Application is broken when visit from /graphql to / in disconnected mode
  • PR #403 [React sample] Doesn't work with url ip:port
  • PR #404 [sitecore-jss-react][React sample] Fix invalid types, fix invalid type in data/*.yml
  • PR #406 [sitecore-jss-angular] Prevent the Angular scLink directive from adding an empty href attribute
  • PR #409 [sitecore-jss-angular] Prevent the Angular scLink directive from adding an href attribute, when href is equal to http:// or https://

SXA and Sitecore Forms compatibility table

Sitecore JSS SXA Forms
10 15.0 10 Yes
10 14.0 10 Yes
9.3 13.1 9.3 Yes
9.3 13.0 9.3 Yes
9.2 12.0 1.9 Yes
9.1.1 11.1 1.9 No
9.1 11.0 No No
9.0 11.0 No No

Sitecore JSS 14.0.4

Bug Fixes

  • Commit [sitecore-jss-rendering-host] Upgrade security vulnerable "yargs-parser"

Sitecore JSS 14.0.3

Bug Fixes

  • PR #471 [node-headless-proxy] Upgrade lodash, node-fetch libraries

Sitecore JSS 14.0.2

Bug Fixes

  • PR #455 [React sample] Race condition, under load React app may render HTML from a different route

Sitecore JSS 14.0.1

Bug Fixes

  • Commit [Doc] Describe that global styles, scripts can't be inserted when a component is added to a route in Experience Editor
  • PR #396 [Doc] Update tracking doc as it had a link that 404'ed
  • PR #355 [Doc] Add rendering host documentation
  • PR #394 [React sample rendering-host] Setup in order to run rendering host script
  • Commit [React sample] Cannot read property 'fields' of undefined
  • Commit [React sample] Fix dev dependencies versions

Sitecore JSS 14.0 for Sitecore 10

Upgrading

There are migration instructions from JSS 13-based applications.

New Features & Improvements

  • PR #347 Fixes withSitecoreContext typescript definition
  • PR #350 The types of the render functions in the Placeholder component props are not correct or missing

SXA and Sitecore Forms compatibility table

Sitecore JSS SXA Forms
10 14.0 10 Yes
9.3 13.1 9.3 Yes
9.3 13.0 9.3 Yes
9.2 12.0 1.9 Yes
9.1.1 11.1 1.9 No
9.1 11.0 No No
9.0 11.0 No No

Sitecore JSS 13.2 for Sitecore 9.3

New Features & Improvements

  • PR #357 [Forms] Implement FileUpload field
  • Commit [Doc][Form] Document how to customize FormFetcher of the component

Bug Fixes

  • PR #381 [Doc] Minor formatting fix in JSS Server Setup documentation
  • PR #388 [Doc][node-headless-ssr-proxy sample] - Fix broken Headless SSR mode link

Sitecore JSS 13.1 for Sitecore 9.3

New Features & Improvements

  • PR #357 [Doc] Updated context extension docs around caching
  • Commit [Doc] Extend JSS Forms documentation regarding customizing labels of different field types
  • Commit Add --skipValidation for jss setup command
  • PR #338 Section field template can use FormFieldSection in order to pass cssClass to the fieldset element and be able to customize the styles for it.
  • PR #346 Responsive image srcset fallback with src output
  • PR #303 [React-Native sample] documentation is improved and extended.

Bug Fixes

  • PR #373 [Vue Sample] Fix route changes with path and a hash
  • Bug #141 Cannot add components to placeholder without saving first
  • PR #374 [React sample] Fixed start:connected-ssr npm script
  • Commit [Doc] Sitecore Forms + JSS article doesn't mention that the provided sample doesn't work for Headless mode
  • Bug #348 Publishing configuration for sitecore-jss-angular gives errors for Angular 9 ngcc
  • Commit [React sample] 'deploy template' does not accept --acceptCertificate
  • Bug #358 [Vue sample] SSR - fixed hydration bailouts
  • Bug #360 Quick Start with vue is failing
  • Bug #363 Wrong Type Definition for ItemLink
  • Bug #328 Item Links failing to find reference with disconnected mode
  • PR #341 jss setup does not work with Sitecore Docker
  • PR #359 Add description of import service URL question
  • PR #356 [Doc] Fix broken react-native link on homepage
  • Bug #299 SitecoreContextReactContext.Provider is not working properly, because value never changes as it is always same class instance
  • Bug #333 [Doc] Document addPlaceholder function
  • PR #353 [Doc] Move Forms installation documentation section above sample implementation
  • PR #351 [React sample] Include polyfills for IE11
  • Bug #257 [Doc] Add doc for --acceptCertificate param
  • Bug #336 [Vue sample] CLI deploy options do not trigger build step
  • PR #337 [Vue sample] set i18n initial language based on SSR language
  • PR #335 Vue sample Specimen component updated with correct implementation path
  • Bug #287 Potential memory leak in React SitecoreContextFactory
  • PR #300 [React sample] set i18n init lang to prevent SSR hydration from re-rendering app
  • Commit react app - Cannot read property 'forEach' of undefined
  • Bug #314 Angular scaffolding has error in polyfill.ts
  • Bug #311 [React sample] npm run eject throws error
  • PR #281 Wrong GraphQLEndpoint assembly name
  • PR #302 Correctly evaluates the value of SITECORE_ENABLE_DEBUG variable
  • PR #285 Commit Include media from Droptree and Multilist content
  • PR #306 [Doc] Docs missing configuration of fetcher

SXA and Sitecore Forms compatibility table

Sitecore JSS SXA Forms
9.3 13.1 9.3 Yes
9.3 13.0 9.3 Yes
9.2 12.0 1.9 Yes
9.1.1 11.1 1.9 No
9.1 11.0 No No
9.0 11.0 No No

Sitecore JSS 13.0 for Sitecore 9.3

Upgrading

There are migration instructions from JSS 12-based applications.

New Features & Improvements

  • JSS Rendering host

  • Updated:

    • React: from 16.3.0 to 16.12.0,
    • Angular: from 7.0 to 8.2.8,
    • Vue: from 2.5.17 to 2.6.10
    • React-Native: 0.55.4 to 0.60.5

    and all their dependencies has been updated to their latest versions (#252, #255, #256, #266, #269, #282)

  • New React Native sample app added (implemented similarly to existing Styleguide sample apps)

  • Documentation updates

Bug Fixes

  • Bug #224 Export SitecoreContextReactContext
  • Pull #223 Allow lazy loaded components to show a loading state
  • Pull #224 Allow Scoped Styles to Work With Child Components
  • Bug #61 Nested component definitions via Item Link returns only IDs
  • Pull #146 Added support for TypeScript when jss build'ing
  • Bug #267 Error in description of one of methods of Manifest interface
  • Bug #220 Use Object.entries instead of Object.keys
  • Bug #172 mediaApi.updateImageUrl loses revision querystring
  • Bug #189 DevTools loading hidden files and crashing
  • Bug #160 Node Proxy: CURL URL -IL returns 500 OK

Breaking Changes

SXA and Sitecore Forms compatibility table

Sitecore JSS SXA Forms
9.3 13.0 9.3 Yes
9.2 12.0 1.9 Yes
9.1.1 11.1 1.9 No
9.1 11.0 No No
9.0 11.0 No No

Sitecore JSS 12.0.1 for Sitecore 9.2

Upgrading

No special upgrade steps needed, it's safe to promote to newer version.

Bug Fixes

  • Bug #324 Sitecore jss + proxy has degrading performance in amount of requests served per second

Sitecore JSS 12.0 for Sitecore 9.2

Upgrading

No special upgrade steps needed, it's safe to promote to newer version.

New Features & Improvements

  • JSS now supports Sitecore Forms. This means several things:
    • JSS now provides a special content resolver for form components, which enables the Layout Service to send complete serialized form data
    • A new framework-agnostic npm package is available (sitecore-jss-forms), which defines data types and components for forms.
    • A React implementation of forms is also available via the new sitecore-jss-react-forms package (this package extends sitecore-jss-forms)
    • Read about the Forms Service here
    • Read forms documentation here

Note: JSS 12.0 includes all the features of JSS 11.1

SXA and Sitecore Forms compatibility table

Sitecore JSS SXA Forms
9.2 12.0 1.9 Yes
9.1.1 11.1 1.9 No
9.1 11.0 No No
9.0 11.0 No No

Sitecore JSS 11.0.4

Bug Fixes

  • PR #453 [React sample] Race condition, under load React app may render HTML from a different route

Sitecore JSS 11.0.3 for Sitecore 9.1.1

Upgrading

No special upgrade steps needed, it's safe to promote to newer version.

Bug Fixes

  • Bug #324 Sitecore jss + proxy has degrading performance in amount of requests served per second

Sitecore JSS 11.1 for Sitecore 9.1.1

Upgrading

No special upgrade steps needed, it's safe to promote to newer version.

New Features & Improvements

  • JSS now integrates with SXA. When SXA is installed, it's possible to create JSS tenants and sites that make it easier to scale JSS apps. Additional benefits:
    • SXA site management for JSS apps.
    • Cross-site presentation sharing using page designs and partial designs.
    • Cross-site content sharing.
    • Cross-site reusability of renderings.
    • Cross-site linking.
    • More info available on the SXA documentation site
  • Angular projects can now take advantage of the new *scRouterLink component which creates a link that uses Angular routing from a Sitecore link field, instead of refreshing the page.
  • Angular placeholders now expose a loaded event that can be hooked for apps that need to know when a placeholder is done loading, i.e. <sc-placeholder [...] (loaded)="onPlaceholderLoaded($event)"></sc-placeholder>
  • PR #214 Pass through component props types when using withSitecoreContext
  • PR #213 Add angular directive for general links that can be both internal and external. This allows Content Editors to not be limited to one type of predefined linkfield while maintaining angular routerlinks
  • The documentation site now has an initial draft of a new "guided learning" area for the JSS Developer Trial: https://jss.sitecore.com/connected-demo

Bug Fixes

  • PR #211 Fix the case when working on a mac or linux with git config for autocrlf all the line endings in the repo are set to lf which fails eslint
  • Bug #194 Implement acceptCertificate parameter in jss deploy component/template
  • Bug #174 Resolve inherited templates/fields when building media output for the manifest
  • PR #170 Changed proptypes of missingComponentComponent and errorComponent to PropTypes.func in packages/sitecore-jss-react/src/components/PlaceholderCommon.tsx to prevent console warning "Warning: Failed prop type: Invalid prop missingComponentComponent of type function supplied to PlaceholderComponent, expected object."
  • PR #151 Re-add !noDebug to jss-proxy console logging to allow disabling of logging.
  • Various fixes to docs (Thank you, community!!)

Sitecore JSS 11.0 for Sitecore 9.0 and 9.1

New Features & Improvements

  • JSS Import is now Helix-compatible. This means several things:
    • JSS' templates now reside in /sitecore/templates/Foundation instead of /sitecore/templates
    • Imported apps will by default import into a Project-layer module (i.e. /sitecore/templates/Project/MyAppName)
    • See the upgrade guide if updating from a technical preview; it is possible to retain the TP-style import paths.
  • JSS now ships with a tracking API that enables JSS apps to push Sitecore analytics events (events, goals, outcomes, campaigns, page views) back to xConnect from the client-side. The JSS React styleguide has an interactive example of using the tracking API.
  • JSS apps support Sitecore's robot detection algorithms, enabling collection of analytics traffic without disabling robot detection. Apps must use a VisitorIdentification component placed on their main route shell to enable this support.
  • The sitecore-jss package no longer depends on axios for making Layout Service requests. This gives consumers flexibility to provide their own HTTP implementations. The migration instructions detail how to handle this for upgraders.
  • JSS Angular now ships with built-in component lazy loading support.
  • GraphQL API now supports paginating item children using the first and after cursor pagination parameters.
  • GraphQL API can filter out non-local template fields on the Item's fields property via the new ownFields parameter.
  • GraphQL now supports HTTP GET for Automated Persisted Queries. This enables some CDN cacheability scenarios.
  • JSS apps' GraphQL endpoints are configured to automatically lock down schema introspection on Content Delivery servers.
  • JavaScript renderings now support pooled Node SSR. See the JS rendering sample /sitecore/config for details.
  • Rendering Parameters Templates will now be created during import when a disconnected manifest defines rendering parameters on a component. This enables editors to have explicit fields to edit each parameter.
  • Layout Service will now return the Sitecore Context JSON data even if a route item is not resolved. This means that apps' 404 routes will have access to LS context data, such as the site name and language, as well as any context extensions that may have been added - such as global navigation data. LS will still return HTTP 404 in these cases; just now with extra context data. Sample apps' 404 routes demonstrate using this pattern. Also applies to disconnected mode.
  • It is now possible to specify icons for routes and content items in disconnected data, for example icon: Network/16x16/home.png at the root of the YAML.
  • Installing the JSS Server Sitecore package now automatically adds the JSS media handler to the web.config file, so this installation step is no longer required.
  • JSS react sample will treat .jsx files as components when generating the component factory, in addition to .js
  • Layout Service can now accept item IDs or short IDs in addition to paths when fetching layout data.
  • The JSS CLI now supports a --proxy option when deploying items or creating new apps. This enables JSS to deploy items in environments that use HTTP proxies. It is also possible to configure the proxy using envionment variables.
  • The path to the Node executable to use in integrated mode can now be set on the View Engine instance config (see Sitecore.JavaScriptServices.ViewEngine.Node.config, NodePath), instead of always using node on the system PATH. This enables different node versions per site.
  • JSS services (LS, GraphQL, tracker, dictionary) can now accept JWT tokens returned by the SSC auth service, instead of only cookie-based authentication. Both bearer tokens and the token header are allowed to pass the JWT payload.
  • Sitecore 9.1 XM-only mode is supported. XM-only installs must use the XM server components package to avoid installing any XP dependencies. Behavioural personalization and tracker APIs are not available in XM mode.
  • The node-headless-ssr-proxy example can now accept common proxy configuration variables from environment variables, in addition to config.js settings. This makes it easier to share proxy code in containers and PaaS hosts where environment variables are commonly used. See the README for details.
  • jss setup can now help setup connections to remote Sitecore installations, not just local Sitecores. In addition, setup will read any existing configuration and use those values as defaults if it is run on an already setup site.
  • jss deploy items (and deploy app) can now accept a --acceptCertificate parameter that whitelists a SSL certificate by thumbprint (certificate pinning). Because Node does not respect Windows trusted root certificates, this enables deploying items to local Sitecore instances that use self-signed certificates without disabling SSL validation entirely.
  • The onError and createViewBag hooks in sitecore-jss-proxy can now return promises, allowing for async processing during headless SSR
  • The disconnected mode layout service now supports a customizeRendering hook in addition to customizeRoute and customizeContext. This hook function allows you to customize the JSON returned for specific components in disconnected mode - enabling advanced data mocking scenarios and the ability to replicate layout service customizations while disconnected.

Important Changes

  • JSS no longer supports using yarn with its sample applications. Yarn will also no longer be used by the JSS CLI if it is installed.
    • Existing yarn users: ok to keep using it. We no longer support it to enable shipping a consistent set of dependency versions with the starter apps, not because it cannot work.
  • GraphQL endpoints must now be individually whitelisted using SSC API keys' Allowed Controllers field. * still whitelists everything, but when specifying allowed controllers you must whitelist the Sitecore.Services.GraphQL.Hosting.Mvc.GraphQLController as well as each GraphQL endpoint using GraphQL:/url/to/endpoint syntax instead of a C# type name. For example: Other.Controller, Other.Assembly;Sitecore.Services.GraphQL.Hosting.Mvc.GraphQLController;GraphQL:/api/jssreactweb
  • The location of SSC API key items has changed in Sitecore 9.1. They now reside in the master database, not the core database. You can transfer existing API keys by using the Transfer option in content editor.
  • Insert options are no longer magically added to route templates during import. Control over route insert options is now given to the manifest author. The migration instructions detail how to handle this.
  • The behaviour of Link-rendering JSS helper components has been changed to match with normal Sitecore link rendering. Previously if no text (or description in Sitecore) was set for an external link, the link would render blank. In JSS 11.0, the link will use the href value like the Sitecore MVC link renderer will (for all supported languages).
  • The configuration scheme of the node-headless-ssr-proxy example has been refactored, and all configuration is now contained within config.js instead of both index.js and config.js. Making this refactor to existing usages of this example is optional.
  • Behavior of the proxy ignore list for sitecore-jss-proxy has been modified. It is no longer required to URL-encode (i.e. %20) ignored paths that contain characters that need encoding in URL strings. This does not affect the default configuration, but would affect custom configurations such as /sitecore%20modules that would now need only be /sitecore modules.

Bug Fixes

  • Importing a JSS application that has no version in the Sitecore default language will work correctly
  • Enabling Node debugging on an integrated mode JSS app with a Node pool size greater than 1 will now reduce the pool size to 1 instead of causing port conflicts
  • JSS apps will support Content Testing via workflow correctly when using the JSS Default Workflow
  • Layout Service will no longer return HTTP 401 in some cases when it should return HTTP 404
  • jss setup --nonInteractive requires fewer arguments to succeed, for CI scenarios that do not need the complete set of JSS CLI capabilities.
  • JSS rendering insert options are now managed by a global insert option rule, which ensures the option is always available for easier Sitecore-first development.
  • Missing insertOptions property has been added to the template definition TypeScript typings.
  • Imported content items will no longer have insert options explicitly set on each item, and will use standard values instead.
  • It is now possible to use Experience Editor on route template standard values by explicitly specifying the JSS app name to render with the sc_jssapp query parameter.
  • GraphQL will return the correct URL when querying media items' url field directly (creating the URL with MediaManager)
  • GraphQL will return proper error messages when IIS custom errors are enabled, instead of HTTP 400 with no explanation (i.e. for missing API keys)
  • Setting a defaultWorkflow during app import is correctly optional
  • Error messages from JSS services are better when IIS custom errors are enabled
  • The node-headless-ssr-proxy example will correctly perform startsWith() instead of indexOf() matching on proxy-excluded paths. This prevents excluding /foo from also excluding /bar/foo. Path matching is also now case-insensitive to match Sitecore convention.
  • SSL certificate validation is no longer disabled by default in node-headless-ssr-proxy, which is a security issue.
  • The node-headless-ssr-proxy example will server-side render dictionaries correctly.
  • The sitecore-jss-proxy library will no longer double-encode incoming URLs that contain encoded characters, such as spaces (%20), when proxying to the Layout Service.