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 strictly adhere to Semantic Versioning. Major versions of this project may include breaking changes in core packages but also denote compatibility with Sitecore Platform versions. Refer to the "Headless Services" section in the Sitecore modules compatibility table (Sitecore XP 7.5 - 9.3, Sitecore XP 10.0 and later) or the Headless Rendering download page for details. Minor versions may also include breaking changes in framework packages.

Our versioning strategy is as follows:

Patch: no breaking changes (e.g. bug fixes, minor improvements)
Minor: may include breaking changes in framework packages (e.g. framework upgrades, new features, improvements)
Major: may include breaking changes in core packages (e.g. major architectural changes, major features)

Unreleased

🎉 New Features & Improvements

🐛 Bug Fixes

[templates/nextjs-sxa] Fix shown horizontal scrollbar in EE mode. (#1625), (#1626)

21.4.0

🎉 New Features & Improvements

[templates/nextjs-sxa] [sitecore-jss-react] [sitecore-jss-nextjs] "Bring Your Own Code" (BYOC) feature is introduced. This allows developers and editors more flexibility when developing and working with new components, i.e.:
- Avoid the jss deploy process for components, and use FEAAS registration instead
- Put components anywhere in the project,
- Use any prop type, without dependence on Layout Service data
Check the BYOC documentation for more info. (#1568) (#1603)(#1605)
[templates/nextjs-sxa] Scaffolding components for BYOC is added. Use '--byoc' flag at the end of jss scaffold command to create a boilerplate component for BYOC (#1572)
[sitecore-jss-nextjs] Stylesheet loading via page head links for FEAAS and BYOC is implemented. This allows stylesheets to be loaded during SSR and avoid extra calls on client. (#1587)
[templates/nextjs] Scaffold new components outside of 'src/components' folder by specifying a path with src in it, i.e. jss scaffold src/new-folder/NewComponent (#1572)
[sitecore-jss] [sitecore-jss-nextjs] [templates/nextjs] Introduce performance metrics for debug logging (#1555)
[templates/nextjs] [templates/react] [templates/vue] [templates/angular] Introduce layout service REST configuration name environment variable (#1543)
[templates/nextjs] [sitecore-jss-nextjs] Support for out-of-process editing data caches was added. Vercel KV or a custom Redis cache can be used to improve editing in Pages and Experience Editor when using Vercel deployment as editing/rendering host (#1530)
[sitecore-jss-react] Built-in MissingComponent component can now accept "errorOverride" text in props - to be displayed in the yellow frame as a custom error message. (#1568)
[templates/nextjs] [sitecore-jss-nextjs] Better error handling for component-level data fetching (#1586)
[sitecore-jss-react] Fetch Data for FEaaS Components as part of Component SSR/SSG (#1586)
[sitecore-jss-dev-tools] [templates/nextjs] [templates/react] Introduce "components" configuration for ComponentBuilder (#1598)
[sitecore-jss-react] [sitecore-jss-nextjs] Component level data fetching(SSR/SSG) for BYOC (#1610) (#1621)
[sitecore-jss-nextjs] Reduce the amount of Edge API calls during fetch getStaticPaths (#1612)
[sitecore-jss] [templates/nextjs] [templates/nextjs-sxa] GraphQL Layout and Dictionary services in base remplate, and ErrorPages service in nextjs-sxa can handle endpoint rate limits through retryer functionality in GraphQLClient. To prevent SSG builds from failing and enable multiple retries, set retry amount in lib/dictionary-service-factory and lib/layout-service-factory (#1618 #1619)
[templates/nextjs] [sitecore-jss-nextjs] Upgrade Nextjs to 13.4.16(#1616)

🧹 Chores

Automatically create a Jira Issue once a github issue/doc request/PR is created (#1573)
Use exact canary version instead of range (#1553)

🐛 Bug Fixes

[tempaltes/nextjs] [templates/nextjs-sxa] [sitecore-jss-nexjts] Redirects don't work when file extensions present in a route (#1566)
[templates/vue] "lint" command is failing due to bug introduced by eslint-plugin-prettier (#1563)
[sitecore-jss-react] [FEaaS] Prevent extra components client-side requests for SSR (1541)
[sitecore-jss-react] Remove use of reactDom/server from React Image (1544)
[sitecore-jss-nextjs] Referrer is not captured by Personalize middleware (#1542)
[sitecore.jss-react] Fix double placeholder in Experience Editor in production mode (#1557)
[sitecore-jss-nextjs] Fix of redirects middleware. Add possible to use tokens like $1, $2, $3, etc. (#1547) (#1559) (#1561) (#1562)
[templates/nextjs-sxa] Change Content-Type of robots.txt response (text/html;charset=utf-8➡text/plain).
[templates/nextjs-sxa] Fix styles of Image component for Banner variant when we try to edit image in EE for Basic Site (#1588) (#1596)
[templates/nextjs-sxa] Fix style for main layout(horizontal scrollbar). (#1589)
[templates/nextjs-sxa] Don't let Image component wrap with tag when TargetUrl is not configured. (#1593)
[templates/nextjs] Next config header plugin for CORS. (#1597)
[templates/nextjs] Ensure dictionary data is only fetched when layout data is present for a route (#1608)
[templates/nextjs-personalize] Fix cookie domain for localhost (#1609)
[sitecore-jss-react-forms] Form should be blocked while submit is in progress to avoid submit spam (#1611)
[templates/nextjs] Fix linting errors, fix type error by upgrading @react/types to v18.2.22 (#1613)

🛠 Breaking Changes

[templates/nextjs] [sitecore-jss-nextjs] Upgrade @sitecore/engage to 1.4.0 also, this dependency has been added to @sitecore-jss-nextjs package to make use of the latest features from the SDK. (#1609)

21.3.1

🐛 Bug Fixes

[create-sitecore-jss] This is a maintenance release to fix package versioning in JSS templates.

21.3.0

🎉 New Features & Improvements

[sitecore-jss-nextjs] Support for public URL resolution in Netlify (#1585)

🛠 Breaking Changes

[sitecore-jss-angular] [sitecore-jss-angular-schematics] [templates/angular] Angular is updated to v15. This update includes the below major version upgrades and changes. Please make sure your codebase is updated to accomodate the changes in the above dependencies. (#1604 #1607)
- Angular update: https://github.com/angular/angular/releases/tag/15.0.0
- Angular CLI: https://github.com/angular/angular-cli/releases/tag/15.0.0
- Angular ESLint: https://github.com/angular-eslint/angular-eslint/releases/tag/v15.0.0
- rxjs: https://rxjs.dev/6-to-7-change-summary
- Angular sample has been updated to use ES2022.

21.2.4

🎉 New Features & Improvements

[templates] Add JSS_APP_NAME to .env files (#1571)

🐛 Bug Fixes

[sitecore-jss] GraphQLSiteInfoService does not fetch more than 10 sites (#1569)
[sitecore-jss-vue] Link component renders link description even when children are provided (#1570)
[sitecore-jss-dev-tools] Fix line endings for component builder (#1580)
[templates/nextjs-sxa] Fix font awesome - added CDN instead of using node_modules(problem with CORS) (#1536 (#1545)
[templates/nextjs-sxa] Fix menu component of third-level menu. (#1540) (#1546)

21.2.3

🐛 Bug Fixes

[tempaltes/nextjs] [templates/nextjs-sxa] [sitecore-jss-nexjts] Redirects don't work when file extensions present in a route (#1566)

21.2.2

🐛 Bug Fixes

[sitecore-jss-nextjs] Fix of redirects middleware. Add possible to use tokens like $1, $2, $3, etc. (#1547) (#1559) (#1561) (#1562)

21.2.1

🧹 Chores

Update outdated documentation links (#1539)

21.2.0

🎉 New Features & Improvements

[templates/nexts] [sitecore-jss-dev-tools] [sitecore-jss-nextjs] Move template related script to the base package (#1520):
- [sitecore-jss-nextjs]:
  - Introduced ComponentBuilder class for generating component factories and module factories.
  - ComponentPropsService componentModule property renamed to moduleFactory.
  - Adjusted ComponentModule definition:
    - renamed to ModuleFactory.
    - Module type besides the initial limited set of props now can also include any React component. React.Component is replaced by React.ComponentType.
- [sitecore-jss-dev-tools]:
  - Introduced nextjs submodule, which contains component builder generation functionality.
- [templates/nextjs]:
  - Introduced plugins architecture for component builder and scaffold component generation processes.
  - Reused new utils added to sitecore-jss-dev-tools.
[templates/react] [sitecore-jss-dev-tools] Refactoring for react template (#1506)(#1515):
- [templates/react]:
  - Introduced plugins architecture for boostrap, config and component builder generation process
  - Updated components tree to represent the structure: fields, styleguide, graphql folders.
- [sitecore-jss-react] Introduced ComponentBuilder class for generating component factories
- [sitecore-jss-dev-tools]:
  - Introduced react submodule, which contains component builder generation functionality
  - Added common utils for plugins, file generation
[templates/nextjs-personalize] Disable page view tracking event in development (#1414)
[templates/nextjs-sxa] Add custom template for jss scaffold (#1420)
[sitecore-jss-react] [sitecore-jss-nextjs] FEaaS component will render 'staged' variant for editing and preview and 'published' variant for live site by default, unless variant is overriden via rendering parameters. (#1433)
[templates/nextjs] [templates/angular] [templates/react] [templates/vue] Pre-push hook for lint check (#1427) (#1442) (#1444) (#1468) (#1472)
`[sitecore-jss-nextjs] Add a new handling for token $siteLang(context site language) in middleware redirect (#1454)
[sitecore-jss] [templates/nextjs-sxa] Rewrite logic of handling custom error pages. The error pages rewrite page with error(it's saving status code) instead of redirected (#1469) (#1476)
[templates/nextjs] Remove .babelrc to (re)enable SWC compilation by default (#1483)
[sitecore-jss] Handle null items in graphql layout service. (#1492)
[templates/nextjs-personalize] [sitecore-jss] Update the default personalize middleware, personalize/cdp service timeout values to 400 (#1507)
[templates/react] [templates/angular] [templates/vue] Remove persisted query link since APQ(Automatic Persisted Queries) is not supported on Sitecore Experience Edge Delivery (#1420)
[sitecore-jss] [templates/nextjs-personalize] Introduced optional personalize scope identifier to isolate embedded personalization data among XM Cloud Environments that are sharing a Personalize tenant (#1494)
[sitecore-jss-nextjs] Add prefetchLinks paramter to the RichText component to allow prefetching of links to be enabled/disabled (#1517)

🧹 Chores

Automated API doc generation and added packages/samples filter (#1470)(#1474)
Revisit and update github ISSUE_TEMPLATE (#1445)
Configure the recommended VSCode extensions for the starters (#1437)
[templates/nextjs] [templates/nextjs-styleguide-tracking] Move remaining Styleguide-Tracking artifacts from the base template (#1422)
Fix API Doc generation (#1464)
Update Sitecore logos (#1467)
Fix security vulnerabilities (#1381)
[templates/nextjs-sxa] Move some dependencies to devDependencies (#1489)
[templates/nextjs-sxa] Clarify rootItemId usage for Dictionary Service in SXA sites (#1409)

🐛 Bug Fixes

[templates/angular] [templates/vue] Link component does not add anchor to the internal links (#1511)
[templates/react] [React] Cannot find package '@babel/plugin-proposal-export-namespace-from' (#1510)
[templates/angular] [templates/vue] Sitecore service endpoint is not proxied in Connected mode (#1465)
[templates/nextjs] Healthz shows page not found for multisite setup (#1443)
[sitecore-jss-react] Hydration error when render Link in Edit mode (#1432)
[sitecore-jss-nextjs] Fix for Link component which throws error if field is undefined (#1425)
[templates/react] Fix compilation error when developing react template in monorepo (#1428) (#1451)
[sitecore-jss-nextjs] Fix regex for middleware redirects (#1431)
[sitecore-jss-angular] Fix memory leak in image and link components (#1435)
[templates/nextjs-multisite] Fix skipped site info fetch (#1434)
[angular] Fix app build errors. Webpack version is locked at 5.78 due to webpack/webpack#16981 (#1448)
[sitecore-jss-nextjs] Fix middleware redirect when the target use regexp with querystring (#1449) (#1460)
[templates/nextjs] Fix incorrectly named .gitignore file \scripts\temp\.npmignore (#1463)
[angular] Avoid sending two dictionary service calls when switching language and refreshing the page (#1473)
Fix installed sitecore-jss-* dependency version (#1478)
[node-headless-ssr-experience-edge] Add helper comment for rootItemId (#1491)
[templates/nextjs-sxa] Add condition DISABLE_SSG_FETCH for 404/500 pages to enable full ISR (Incremental Static Regeneration) flow (#1496)
[templates/nextjs-sxa] Fix class .indent for component which have column size 12 (#1505)
[templates/nextjs-sxa] Fix type(from Text to RichText) of editing text in value Text2 for Promo Component in WithText variant (#1504).
[sitecore-jss-nextjs] Fix RichText component to re-initialize links when content changes (#1503)
[angular] [react] [vue] [nextjs] Prevent personalized component rendering errors when default variant is hidden (#1383)
[vue] Fix disconnected mode not starting in monorepo setup (#1418)
[sitecore-jss-proxy] The rewriteRequestPath function ignores query string parameters added in a middleware(#1373) (#1379)
[templates/react] [React] Fix build error (#1505)
[templates/vue] [Vue] Fix integrated mode error (#1505)

🛠 Breaking Changes

[templates/nexts] [sitecore-jss-dev-tools] [sitecore-jss-nextjs] Move template related script to the base package (#1520):
- [sitecore-jss-nextjs]:
  - ComponentPropsService fetchServerSideComponentProps, fetchStaticComponentProps methods accept params.moduleFactory instead of params.componentModule.
  - Exports ModuleFactory instead of ComponentModule.
[sitecore-jss-react] [sitecore-jss-nextjs] FEaaS component is now server rendered. Prop type used FEaaSWrapper has been modified alongside with FEaaSWrapper implementation. Make sure you use the updated type and the updated wrapper. (#1413) (#1513)
[sitecore-jss-rendering-host] startDevServer is retired. startRenderingHostServer is the only way to start the rendering host from now on. (#1426)
[sitecore-jss-nextjs] Some imports have been moved to avoid accidentally importing nextjs server logic inside client componenents(#1430):
- SiteInfo and SiteResolver imports have been moved from '@sitecore-jss/sitecore-jss-nextjs/middleware' module to '@sitecore-jss/sitecore-jss-nextjs/site'
- tryParseEnvValue import has been moved from '@sitecore-jss/sitecore-jss-nextjs/middleware' module to '@sitecore-jss/sitecore-jss-nextjs/utils'
- exports for isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue, handleEditorFastRefresh, getPublicUrl from '@sitecore-jss/sitecore-jss-nextjs' are depreceated. '@sitecore-jss/sitecore-jss-nextjs/utils' module should be used for them instead.

21.1.7

🐛 Bug Fixes

[React] Cannot find package '@babel/plugin-proposal-export-namespace-from' (#1510)

21.1.6

🐛 Bug Fixes

[templates/nextjs-sxa] Add condition DISABLE_SSG_FETCH for 404/500 pages to enable full ISR (Incremental Static Regeneration) flow (#1496)

21.1.5

🐛 Bug Fixes

[create-sitecore-jss] Change ^ to ~ for versioning in templates and use exact versions for sitecore-jss monorepo dependencies.

21.1.4

🐛 Bug Fixes

[create-sitecore-jss] Change ^ to ~ for versioning in templates.

21.1.3

🐛 Bug Fixes

Fix installed sitecore-jss-* dependency version. Change ^ to ~ (#1481)

21.1.2

🎉 New Features & Improvements

[sitecore-jss] [templates/nextjs-sxa] Rewrite logic of handling custom error pages. The error pages rewrite page with error(it's saving status code) instead of redirected (#1469) (#1476)

🐛 Bug Fixes

[templates/angular] Fix app build errors. Webpack version is locked at 5.78 due to webpack/webpack#16981 (#1448)

21.1.1

🐛 Bug Fixes

[sitecore-jss-nextjs] [SXA] fixed middleware redirects (#1431)

21.1.0

🎉 New Features & Improvements

[create-sitecore-jss] [sitecore-jss-nextjs] [templates/nextjs] [templates/nextjs-multisite] New nextjs-multisite initializer add-on. Allows a single JSS Next.js app to serve multiple Sitecore sites. (#1248) (#1288) (#1264) (#1271) (#1275) (#1277) (#1279) (#1281) (#1283) (#1284) (#1286) (#1306) (#1290) (#1294) (#1302) (#1339) (#1360) (#1365) (#1303) (#1304) (#1299) (#1322) (#1361) (#1296)
[templates/nextjs] [sitecore-jss-nextjs] Upgrade Next.js to version 13 (#1324)
[templates/angular] [sitecore-jss-angular] Upgrade Angular to version 14 (#1285) (#1300) (#1300) (#1307)
[templates/nextjs] Finalize @sitecore/engage version upgrade (#1317)
[templates/nextjs] Add healthz check (#1207)
[sitecore-jss] [sitecore-jss-nextjs] Performance improvements for personalize service and middleware (#1218)
[sitecore-jss] [sitecore-jss-nextjs] Update models: Add url and id property to item type (#1219)
[sitecore-jss-nextjs] Add async to editing data cache (#1223)
[templates/nextjs] [sitecore-jss] [sitecore-jss-nextjs] Performance improvement for site redirects service (#1225)
[sitecore-jss-angular] Add canActivate and resolve functionality (#1246)
[templates/react] [templates/nextjs] [templates/vue] [sitecore-jss-nextjs] [sitecore-jss-react] [sitecore-jss-vue] Upgrade 3rd party dependencies (#1250) (#1301) (#1305) (#1321) (#1352) (#1362) (#1327) (#1313) (#1329) (#1338)
[templates/angular] Upgrade bootstrap in sample app (#1308)
[templates/angular] [templates/react] [templates/vue] [templates/nextjs-styleguide] [sitecore-jss-nextjs] [sitecore-jss-react] [sitecore-jss-angular] [sitecore-jss-vue] Edit frame component implementation (#1342)
[sitecore-jss-react] Export DateFieldProps (#1216)

🧹 Chores

[sitecore-jss-vue] Suppress unit test warnings (#1335)
Add test-packages npm command (#1233)
[create-sitecore-jss] [sitecore-jss-nextjs] [sitecore-jss-react] [sitecore-jss-cli] [sitecore-jss] [sitecore-jss-dev-tools] Increase unit test coverage (#1258) (#1259) (#1260) (#1262) (#1263) (#1265) (#1256)
Improve unit test coverage reporting (#1202)
Update CHANGELOG with updated version strategy (#1330)
PR template refresh (#1351)

🐛 Bug Fixes

[templates/nextjs] Additional middleware default exclusions (#1230)
[sitecore-jss] rootItemId not resolvable for different language versions (#1196)
[sitecore-jss-forms] File upload validation error (#1213)
[sitecore-jss-react] [sitecore-jss-nextjs] Link component does not add anchor to the internal links (#1226) (#1375)
[sitecore-jss-proxy] Disable websocket processing by default in proxy (#1311)
[create-sitecore-jss] Incompatibility message when installing sxa and styleguide (#1315)
[templates/angular] The data "This page does not exist" is displayed during loading the page of angular app in EE (#1331)
[sitecore-jss-dev-tools] After upgrade deploy throws 'Cannot calculate proper length in synchronous way.' (#1332)
[templates/nextjs] Sample in Docker env references linked packages using lowercase path (#1334)
[templates/nextjs] [sitecore-jss-nextjs] In Image component exclude width/height when fill prop is provided (#1336)
[sitecore-jss-rendering-host] Fix react rendering host ESM error (#1337)
[templates/nextjs] Nextjs Upgrade bug fixes (#1340) (#1341) (#1346)
[templates/nextjs] Add rewrite for Sitecore's default 404 prefix (#1345)
[sitecore-jss-react] Fix rendering issue in components using withPlaceholder (#1349)
[sitecore-jss-react-forms] The language of the form is changed after clicking the submit button (#1261)
[templates/nextjs-sxa] Cumulative SXA bug fixes (#1319) (#1292) (#1165) (#1245) (#1268) (#1269) (#1272) (#1278) (#1333) (#1185) (#1172) (#1255)
[templates/nextjs-personalize] [sitecore-jss-nextjs] Add support for fallback point of sale (#1367) (#1380)
[templates/vue] Fix local dev server launch error (#1368)
[sitecore-jss-nextjs] Implemented MiddlewareBase abstraction. Skip Redirects middleware during editing (#1370)
[sitecore-jss-nextjs] Redirects middleware should debug log start/end (#1372)

🛠 Breaking Changes

[sitecore-jss-nextjs] [templates/nextjs] [templates/nextjs-personalize] [templates/nextjs-sxa] Middleware configuration for multiple sites (#1288) (#1350) (#1367)
- SiteResolver implementation must be passed into redirects middleware
- SiteResolver implementation must be passed into personalize middleware
- getPointOfSale function passed into personalize middleware now accepts two parameters: site and language. Personalize middleware will use base PosResolver if no function is passed.
[sitecore-jss-angular][templates/angular] jss-angular package and sample has been updated to version 14. (#1285) (#1300)
- JSS Angular sample is now using Ivy
- IE11 no longer supported by JSS Angular
- sitecore-jss-angular package does not output UMD package anymore - only ESM. We created a '@sitecore-jss/sitecore-jss-angular/cjs' sub-module to have CJS imports still available i.e. in angular sample app's scripts. Right now the submodule re-exports '@sitecore-jss/sitecore-jss' modules.
- componentFactory is no longer present in ComponentFactoryResult interface, due to createComponent changes and deprecations introduced in Angular 13.
- More details on changes in Angular can be found in the below links: https://blog.angular.io/angular-v13-is-now-available-cce66f7bc296 https://angular.io/guide/deprecations https://update.angular.io/?l=3&v=11.0-14.0
[sitecore-jss-angular] Due to the Angular version upgrade and the change in sitecore-jss-angular package output format sitecore-jss exports are not available in angular app scripts (src/scripts) via '@sitecore-jss/sitecore-jss-angular'. Please use '@sitecore-jss/sitecore-jss-angular/cjs' import instead. Check bootstrap.ts scripts as for a usage example.

21.0.10

🐛 Bug Fixes

Change ^ to ~ in sitecore-jss templates

21.0.9

🐛 Bug Fixes

Fix installed sitecore-jss-* dependency version. Change ^ to ~ (#1481)

21.0.8

🐛 Bug Fixes

[React] [Nextjs] [FEaaSComponent] Avoid FEAAS Stylesheets parsing multiple times (#1320)

21.0.7

🎉 New Features & Improvements

[sitecore-jss-react] [sitecore-jss-nextjs] Added exports for FEaaSComponent (#1316)

21.0.6

🎉 New Features & Improvements

[sitecore-jss-react] FEaaS Component implementation (#1297)
[templates/nextjs-sxa] FEaaSWrapper Component implementation (#1318)

21.0.5

🐛 Bug Fixes

[templates/nextjs-sxa] Fixed rendering dynamic placeholders filter. (#1292)

21.0.4

🐛 Bug Fixes

[templates/nextjs-sxa] Fixed rendering dynamic placeholders for splitter components. (#1292)

21.0.3

🐛 Bug Fixes

[templates/nextjs-sxa] Fixed rendering dynamic placeholders for splitter components. Added pattern and checking for rendering Dynamic placeholders. (#1278)(#1292)

21.0.2

🧹 Chores

[template/nextjs-sxa] Removed XM Cloud only limitation from nextjs-sxa initializer add-on. This is now compatible with SXP with the release of Sitecore Experience Platform 10.3.

🐛 Bug Fixes

[templates/nextjs] [sitecore-jss-nextjs] Upgrade Next.js version to 12.3.x (#1238)
[templates] Rename "Page" back to "AppRoute" (#1249)
[templates/nextjs-sxa] Cummulative fixes to nextjs-sxa initializer add-on (#1206)(#1215)(#1241)(#1232)(#1229)(#1221)(#1254)

21.0.1

🐛 Bug Fixes

[sitecore-jss] Add sitemap.xml for result of sitemap service (#1217)

21.0.0

Note: JSS 21 is currently compatible with XM Cloud (XMC) only. The release of Sitecore Experience Platform 10.3 will bring compatibility to SXP.

🎉 New Features & Improvements

[templates/nextjs] [sitecore-jss-nextjs] Upgrade Next.js to 12.3.x
[create-sitecore-jss] Personalize Initializer Add-on (#939)
[templates/react] [templates/nextjs] [templates/nextjs-styleguide] [sitecore-jss-nextjs] [sitecore-jss-react] Upgrade react to version 18 (#1055)
[templates] Rename "App Route" to "Page" (#1159)
[templates/nextjs] [sitecore-jss-nextjs] [sitecore-jss] [Editing] Partial rendering implementation (#1169)
[templates/nextjs] Add environment variable to allow disable of sitemap fetch in getStaticPaths (#1149)
[sitecore-jss-react] Allow defer prop on VisitorIdentification component (#1090)
[sitecore-jss] Introduce timeouts (#1057)(#1084)
[sitecore-jss-angular] Extend richText directive to render internal routerlinks (#1050)
[sitecore-jss-nextjs] [sitecore-jss-react] Export more types from jss-nextjs & jss-react (#1043)
[sitecore-jss-vue] RichText support for router links (#1037)
[sitecore-jss] [sitecore-jss-nextjs] [templates/nextjs] Personalize Middleware (#1008)
[sitecore-jss-nextjs] GraphQL sitemap now parses personalize data from site queries (#1005)
[templates/node-headless-ssr-proxy] [templates/node-headless-ssr-exp-edge] [sitecore-jss-proxy] Add typescript to the sample (#1013)
[create-sitecore-jss] Add script to restore yarn.lock (#1004)
[sitecore-jss-nextjs] GraphQL sitemap now parses personalize data from site queries and adds it into returned paths (commit)
[templates/react] [templates/angular] [templates/vue] Support .env file (#999)
[templates/nextjs] [templates/nextjs-styleguide] Move XP tracking API examples to separate add-on initializer (#980)
[templates/node-headless-ssr-proxy] [templates/node-headless-ssr-experience-edge] Provide ability to use .env (#977)
[templates/nextjs] Make extractPath shared and remove duplicate page-props-factory/plugins/normalMode for personalize addon (#954)
[create-sitecore-jss] Add merge (concatenate) functionality for .env files (#952) (#959)
[templates/nextjs] Create plugins approach for the nextjs middleware (#945)
[templates/nextjs] Bump @sitecore/engage to latest version (#1198)
[sitecore-jss-react-forms] Upgrade sitecore-jss-react-forms to React 18 (#1199)

🧹 Chores

Fix Security Vulnerabilities (#986)(#997)(#1114)(commit)
[sitecore-jss] Make it clear that isEditorActive only works in browser (#1089)
[sitecore-jss-angular] Cover class overwrite for scGenericLink and scRouterLink by unit test (#1074)
[sitecore-jss] Audit API reference description for accuracy and completeness (#1031)
[sitecore-jss-angular] Include all files from the dist (#1049)
Resolve .npmingore discrepancies between packages (#1032)(#1034)
Create shared tsconfig.json for the monorepo (#1000)
Add missing doc generation for sitecore-jss-nextjs/middleware (#commit)
Updated slack channel in SUPPORT.md (commit)
[create-sitecore-jss] Restore sub-command (npm install / lint) console output (#933)

🐛 Bug Fixes

[sitecore-jss-react] Resolve hydration errors for nextjs pages in EE (#1161)
[templates/nextjs] [templates/nextjs-styleguide] [templates/nextjs-sxa] Specify AppProps generic type in _app.tsx to align with latest changes from Next 12.3.0 (#1154)
[sitecore-jss-nextjs] Build error when null values received in graphql-sitemap-service.js (#1150)
[templates/react] App in monorepo fails to open in Experience Editor/Headless ssr proxy (#1136)
[sitecore-jss-nextjs] handle _blank target on links in RichText (#1135)
[templates/nextjs] Timeout error on CM when calling Next.js rendering host (#1134)
[templates/nextjs] Updating next to 12.2.4 - and reintroducing babel to avoid swc errors (#1124)
[templates/vue] Fix compilers proxy options in template (#1107)
[templates/react] Module parse failed: Unexpected token, htmlparser2 (#1115)
[sitecore-jss-nextjs] Fix paginated results retrieval in sitemap paths service (#1112)
[sitecore-jss-react] Can't render Link component when Editable and Children are provided (#1095)
[templates/react] Resolve duplicate react instances issue (#1091)
[sitecore-jss-react] Refactored withComponentFactory HOC (#1086)
[sitecore-jss-proxy] Provide headers to response when config.onError is called (#1087)
[sitecore-jss-nextjs] Proper building of query string inside EditingRenderMiddleware (#1071)
[templates/angular] Fix RouteData fields type mismatch (#1067)
[templates/nextjs] [sitecore-jss-nextjs] Add a friendly message when building nextjs app and site items are missing (#1066)
[sitecore-jss] RouteData type doesn't support ContentList/MultiList/DropTree fields (#1061)
[templates/angular] [sitecore-jss-angular] Expose tracking functionality and remove direct usage of sitecore-jss module (#1048)
[sitecore-jss-react] Allow to register custom field components (#1047)
[sitecore-jss-react] VisitorIdentification component now uses sitecore context hook (#1041)
[sitecore-jss-react] Fix misprint in comment (#1028)
[templates/node-headless-ssr-exp-edge] Headless SSR Experience Edge returns 200 for page not found (#1033)
[templates/nextjs] Dynamic components markup is missing in Experience Editor after adding new rendering (#1019)
[templates/node-headless-ssr-proxy] [templates/node-headless-ssr-exp-edge] Fix invalid default bundle path (#1027)
[templates/react]`` [templates/angular] [templates/vue] Remove scjssconfig verification, as .env is used (commit)
[sitecore-jss-nextjs] RichText component not forwarding query params (#1015)
[templates/nextjs-styleguide] Update jss create related info on the home page (#1009)
[templates/angular] [node-headless-ssr-exp-edge] Danish language is not rendered when refresh the page (#1003)
[templates/nextjs-styleguide] [templates/angular] [templates/react] [templates/vue] Fix Styleguide comment path reference (#956)
[templates/nextjs] Fix missing null type for nextjs/Scripts.tsx (commit)
[sitecore-jss-dev-tools] [Manifest] Fix duplicate enum definition (#996)
[template/nextjs-styleguide] Add gitignore (#993)
[templates/node-headless-ssr-proxy] Fix shape of config object (#979)(#992)
[sitecore-jss-vue] Fix Sitecore querystring property in Link component (#974)
[sitecore-jss-react] Make Image handle 'class' prop when it's passed down (#971)
[sitecore-jss-react] [EE] Placeholder key is not defined (#970)
[templates/nexts] [templates/nextjs-styleguide] Use kebab case for plugins, instead of camelCase (#961)
[sitecore-jss-vue] Experience Editor controls does not work until hard reload is done (#951)
[create-sitecore-jss] graphql-let error when bootstrapping empty Nextjs app (#941)
[sitecore-jss] [Angular] "Edit related item" button redirects to home (#943)
[sitecore-jss-vue] Styleguide-Layout-Reuse breaks EE (#937)
[sitecore-jss] Replace abortController.signal with promises timeout in native and graphql fetchers (#1191)
[sitecore-jss] Error message related to timeout is not intuitive (#1197)
[sitecore-jss-nextjs] Ensure headers from middleare are passed into NativeFetcher (#1177)
[templates/nextjs-sxa] Cumulative SXA bug fixes (#1168) (#1181) (#1184) (#1187) (#1189) (#1190) (#1193) (#1194) (#1195) (#1200) (#1203)

🛠 Breaking Changes

Remove deprecated features (#1088)
[sitecore-jss-react] [sitecore-jss-nextjs] Link component should forward ref (#1080)
[sitecore-jss-nextjs] [sitecore-jss] graphql nextjs sitemap update (#1002)(#1007)(#1026)
- Updated GraphQLSitemapService will only work with Sitecore versions that have 'site' query present in edge schema.
[sitecore-jss-nextjs] Performance improvements for editing integration (#1140)
- [sitecore-jss-nextjs] All editing-related types have moved to a dedicated editing submodule. Imports must be updated to use this submodule. e.g.
  - import { editingDataService } from '@sitecore-jss/sitecore-jss-nextjs/editing';
  - import { EditingRenderMiddleware } from '@sitecore-jss/sitecore-jss-nextjs/editing';

20.1.0

🎉 New Features & Improvements

[template/nextjs] [sitecore-jss-nextjs] New NextImage component, a Sitecore Image field helper component for next/image (#978)
[template/nextjs-sxa] New nextjs initializer add-on nextjs-sxa for SXA Headless support (currently compatible with XM Cloud only)
[template/nextjs] [sitecore-jss-nextjs] Upgrade to Next.js 12.2 (#1093)
[sitecore-jss-react] Support SXA Rendering Variants inside the React Placeholder component (#931)
[template/nextjs] Add a friendly message when building nextjs app and site items are missing (#1066)
[create-sitecore-jss] Add descriptions to add-on list (#935)
[template/nextjs] Introduced plugins approach for Next.js Middleware (#945)
[sitecore-jss] Make it clear that isEditorActive only works in browser (#1089)
[template/nextjs] [template/nextjs-styleguide] [template/nextjs-sxa] Specify AppProps generic type in _app.tsx to align with latest changes from Next 12.3.0 (#1155)

🧹 Chores

[template/nextjs] Update obsolete jss create related info on the home page (#1009)

🐛 Bug Fixes

[sitecore-jss-react] Refactored withComponentFactory (#1086) and withSitecoreContext (#1100) HOCs to fix Next.js SSR production issue on React 17
[sitecore-jss-react] Fix Placeholder key is not defined error in Sitecore editors (#970)
[sitecore-jss-react] Make Image handle 'class' prop when it's passed down (#971)
[template/nextjs] Dynamic components markup is missing in Experience Editor after adding new rendering (#1019)
[sitecore-jss-vue] Fix Sitecore querystring property in Link component (#974)
[node-headless-ssr-exp-edge] [sitecore-jss-angular] Danish language is not rendered when refreshing the page (#1003)
[sitecore-jss-nextjs] RichText component not forwarding query params (#1015)

20.0.0

New Features & Improvements

[create-sitecore-jss] New package containing initializers / templates for JSS sample applications. This replaces jss create with initializer of choice (npx create-sitecore-jss, npm init sitecore-jss) (#881), (#883), (#882), (#880), (#879), (#878), (#876)

[template/nextjs]

Remove withSitecoreContext HOC from Layout.tsx (#887)
Component props auto-injection by Placeholder (#884)
Plugins for next.config.js (#867)
Refactor sitemap-fetcher to make it extendable (#865)
Upgrade to Next.js 12 (#860), (#948)
Refactor PagePropsFactory to make it extendable (#857)
Remove locale variants from default rewrites (#832)

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

[template/nextjs] [template/react] [template/angular] [template/vue]

Use the app name as the prefix value for templates (#800), (#811), (#813), (#814)
Throw error when run jss start using FETCH_WITH=GraphQL (#920)
Bring environment variable support to config generation (#911, #commit)
Change the classname of ContentBlock from display-4 to contentTitle (#908)
Hidden renderings do not have implementation and result in console error message (#834)
Use the app name as the prefix value for placeholders (#830)

[sitecore-jss-nextjs] [sitecore-jss-react] Handle Sitecore querystring property in Link component (#929)

[Maintenance] Generate API reference docs (#840)

[sitecore-jss-manifest] [template/nextjs] Allow component manifest definitions to define a template name (#810)

Bug Fixes

[template/*]

Highlight error message for fetchWith=GraphQL (#930)
Fix peer dependency errors (#910)

[template/nextjs]

graphql-let error when bootstrapping empty Nextjs app (#942)
Use more focused paths for Sitecore rewrites (#921
Add .babelrc to Next.js template to disable SWC compilation (#918)
Can't start app in disconnected mode, throws webpack fallback option error (#913)
Add .gitattributes to Next.js sample app with CRLF line endings (#855)
[Horizon] Custom components cannot be added (#807)
Add gitignore (#993)

[template/angular]

[10.3] "Edit related item" button redirects to home (#944)
Update angular-devkit/build-angular to fix deprecation error (#917)
Convert language to the sitecore compatible format (#906)
Fix issues with Angular in disconnected mode (incorrect componentName + reverts changes (#commit)
Opt out of angular telemetry by default (#commit)
Fix handling of not found layout service requests in Angular sample (#809)
Console error when /graphql requested in EE, localhost or horizon (#803)

[template/vue]

The page is redirected to the home page of the website after clicking the "Change associated content" button in the Experience Editor (#907)
Cannot add a new rendering to the newly created (#903)
[Horizon] Cannot add a new rendering or highlight existing (#895)
[Authoring] 'Add here' modal does not show allowed items on placeholder (#859)
Server error for Vue + --fetchWith GraphQL + node-headless-SSR-Experience-Edge (#812)
Fix Vue sample RestLayoutService config (use 'apiHost', not 'endpoint') (#804)

[template/react] Set changeOrigin: true for proxied Sitecore requests in connected mode (#808)

[template/vue] [template/react] Exception while rendering GraphQL page (#900)

[template/react] [template/angular] [template/vue] Fix Template id for styleguide-explanatory-component-template & vue graphql fragment data (#816)

[template/react] [template/angular] [template/vue] jss graphql:update throws errors (#806)

[template/react] [template/angular] [template/vue] Include Sitecore server URL in media URLs by default (#802)

[sitecore-jss]

TypeError: Only absolute URLs are supported (#826)

[sitecore-jss-vue]

Experience Editor controls does not work until hard reload is done (#950)
Styleguide-Layout-Reuse breaks EE (#938)

[sitecore-jss-nextjs]

Prevent passing internalLinkMatcher prop (#847)
Preview Mode doesn't work with fallback: false on Vercel (#846)
[caching] Make tmpDir a configurable parameter (#839)

[sitecore-jss-cli]

Ignore pdf and images when replacing or stripping prefix (#818)
Handle underscores in app name when replacing prefix (#817)

[node-headless-ssr-proxy] [node-headless-ssr-experience-edge] Added submodules import (#916)

[sitecore-jss-nextjs] [sitecore-jss-react] Attributes of an empty placeholder are applied to the next sibling <div> tag in Experience Editor of JSS item (#833)

[sitecore-jss-dev-tools] Fix circular dependencies (#843)

[Maintenance]

Upgrade security vulnerable packages (#866)
Node 16 upgrade (#863)
Resolve deprecated dependencies in sitecore-jss-cli package (#864)
The page is redirected to the home page of the website after clicking the "Change associated content" button in the Experience Editor in angular application (#835)
*scRouterLink breaks link generation (#815)

Breaking Changes

[Maintenance]

Removed sitecore-embedded-jss-app (migrated to https://github.com/Sitecore/headless-examples) and sitecore-javascript-renderings (deprecated) (#commit)
Consolidated tightly coupled packages together and refactored the sitecore base package into submodules. (#824, #commit, #commit)

[sitecore-jss-cli] Error handling for someone trying to run jss create (#893)

[samples] Retire samples (#891)

[template/nextjs] [template/react] Strongly typed SitecoreContext value (#841)

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]

We added API reference docs for the package.

[sitecore-jss-nextjs]

We added API reference docs for the package.

[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.3

Bug Fixes

PR #1309 [sitecore-jss-react-forms] The language of the form is changed after clicking the submit button

Sitecore JSS 15.0.2

Bug Fixes

PR #815 [sitecore-jss-angular] Fix issue where querystring parameters would break links generated with the scRouterLink component.

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

React sample
- Upgraded react-i18next: Migration guide https://react.i18next.com/latest/migrating-v9-to-v10
React-Native sample
- getRouteData function interface is changed. Now it accepts two params: (route, { options, language })
Angular sample
- Lazy loading syntax is changed: https://angular.io/guide/deprecations#loadchildren-string-syntax
- tsconfig.app.json and tsconfig.json: set "module": "commonjs", because dynamic import approach requires this module type
- Typescript 3.5 breaking changes: https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#typescript-35
sitecore-jss-angular package
- ng-packagr: option workingDirectory is removed, removed corresponding getter from NgPackage class. (https://github.com/ng-packagr/ng-packagr/blob/master/CHANGELOG.md#breaking-changes-5)
- Setting ngPackage.src has no effect any more. The source directory (base path) is equivalent to the location of the (primary) ng-package.json, package.json, or ng-package.js. (https://github.com/ng-packagr/ng-packagr/blob/master/CHANGELOG.md#breaking-changes-6)
- The setting for external dependencies (lib.externals) has been removed in favour of lib.umdModuleIds which is now just used to provide the UMD module identifiers of external dependencies. (https://github.com/ng-packagr/ng-packagr/blob/master/CHANGELOG.md#migrating-from-v1-breaking-changes-from-v160-to-v200)
- @angular/core: Default setting for @ViewChild and @ContentChild queries is changed (https://angular.io/guide/static-query-migration#should-i-use-static-true) ComponentNameAndModule interface is changed accordingly to new lazy loading syntax: https://angular.io/guide/deprecations#loadchildren-string-syntax
sitecore-jss-cli package yargs: CommandModule interface is changed https://github.com/Sitecore/jss/pull/272/files#diff-e0b90a991107a0e06b6fa1bb626b6d5eR25

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.

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

Unreleased

🎉 New Features & Improvements

🐛 Bug Fixes

21.4.0

🎉 New Features & Improvements

🧹 Chores

🐛 Bug Fixes

🛠 Breaking Changes

21.3.1

🐛 Bug Fixes

21.3.0

🎉 New Features & Improvements

🛠 Breaking Changes

21.2.4

🎉 New Features & Improvements

🐛 Bug Fixes

21.2.3

🐛 Bug Fixes

21.2.2

🐛 Bug Fixes

21.2.1

🧹 Chores

21.2.0

🎉 New Features & Improvements

🧹 Chores

🐛 Bug Fixes

🛠 Breaking Changes

21.1.7

🐛 Bug Fixes

21.1.6

🐛 Bug Fixes

21.1.5

🐛 Bug Fixes

21.1.4

🐛 Bug Fixes

21.1.3

🐛 Bug Fixes

21.1.2

🎉 New Features & Improvements

🐛 Bug Fixes

21.1.1

🐛 Bug Fixes

21.1.0

🎉 New Features & Improvements

🧹 Chores

🐛 Bug Fixes

🛠 Breaking Changes

21.0.10

🐛 Bug Fixes

21.0.9

🐛 Bug Fixes

21.0.8

🐛 Bug Fixes

21.0.7

🎉 New Features & Improvements

21.0.6

🎉 New Features & Improvements

21.0.5

🐛 Bug Fixes

21.0.4

🐛 Bug Fixes

21.0.3

🐛 Bug Fixes

21.0.2

🧹 Chores

🐛 Bug Fixes

21.0.1

🐛 Bug Fixes

21.0.0

🎉 New Features & Improvements

🧹 Chores

🐛 Bug Fixes

🛠 Breaking Changes