Fixes

• (typescript declarations) Add generics to CustomPropsFn, ParcelConfig, and Parcel (#717)
• (typescript declarations) Remove isStarted from typescript definition, since it's not part of the public API (#717 #715)

Features

• Add option for exact matches in pathToActiveWhen. (#694) Documentation - single-spa/single-spa.js.org#388

Maintenance

• Bump ini from 1.3.5 to 1.3.7 (#681)
• Update slack join link (4988f36)

Fixes

• Add type for custom event detail (#680 via @andygauntnervertex) 43d2ffd
• fix: error message (#678 via @CodeLittlePrince) bd31d08

Maintenance

• Update slack invitation link 7b787a5

v5.8.2...v5.8.3

Fixes

• Only fire artificial popstate events after start() is called. Resolves #655 (#657)
• Wait for mount to finish before attempting to unmount parcels. Resolves #656. (#660)

Maintenance

• Bump dot-prop from 4.2.0 to 4.2.1 (#653)

Fixes

• Fix bug where evt.target for artificial popstate events was null instead of window. See (#651)

Features

• export the unregisterApplication api (#603 via @yangdan8)

Documentation

unregisterApplication('app-name').then(() => {
  console.log('The application is unmounted, unloaded, and no longer registered!');
})

Maintenance

• feat: add file size reporter workflow to PR flow (#622 via @tiagostutz)

Features

• Add support for canceling navigation events (#641)
• Add additional properties to single-spa routing events: oldUrl, newUrl, and navigationIsCanceled (#641)

window.addEventListener('single-spa:before-routing-event', evt => {
  console.log(evt.detail.oldUrl);
  console.log(evt.detail.newUrl);
  console.log(evt.detail.navigationIsCanceled);
  evt.detail.cancelNavigation();
})

Fixes

• Only reload applications that should be active. Resolves #637. This was a regression caused by #546 (#638)

Features

• Make bootstrap lifecycle optional. Resolves #632. (#633)

Maintenance

• docs: fix angular and angularjs link (#610)
• Upgrading to latest babel eslint (#624)

Fixes

• Fixed pathToActiveWhen so that pathname matching allows for arbitrary hashnames after the prefix (@pkhodaveissi #600)

Fixes

• Improve activeWhen to support query-strings in URL (#594 #593 via @Sauloxd)
• Fix types for parcel props (#596 via @kuitos)
• Add console warning when single-spa is loaded twice on the same page. (#577)

Maintenance

• Fix Travis CI badge in Readme (8fdbb93)
• Adding Sponsor button for Github Sponsors and Open Collective. (#582)

Fixes

• Fix bug with delayed call to start() where applications would remain unmounted. (#573 #555)

Fixes

• Small ie11 fixes, and adding lint safe guards for ie11 (#559 via @Sauloxd)
• fix(activeWhen): activeWhen with string literal should be exact match (#565 via @kuitos)

import { registerApplication, checkActivityFunctions } from 'single-spa'

registerApplication({
  name: "app1",
  app: () => System.import('app1'),
  activeWhen: '/app1'
})

// Both 5.5.1 and 5.5.2
checkActivityFunctions(new URL('http://localhost:8080/app1')) // ['app1']
checkActivityFunctions(new URL('http://localhost:8080/app1/sub')) // ['app1']

// With 5.5.1, single-spa did not require the location to have a slash after the prefix
checkActivityFunctions(new URL('http://localhost:8080/app1WithExtra')) // ['app1']

// Changed with 5.5.2 - single-spa now requires the location to have a slash after the prefix
checkActivityFunctions(new URL('http://localhost:8080/app1WithExtra')) // []

Maintenance

• Fix Github issue template (#567 via @kuitos)

Fixes

• Change includes to indexOf for IE11 support. (#558)

Features

• Allow calling checkActivityFunctions without location object as an argument. This is already in the documentation, but wasn't implemented (#544)
• New single-spa:before-app-change and single-spa:before-no-app-change events. (#545 #547)

Fixes

• The CustomEvent.detail for single-spa:before-routing-event and single-spa:before-mount-routing-event now shows the new statuses for apps, meaning the status that the app will be in after the routing event finishes. Previously the current, older status was being reported as the new status. (#547)

Performance

• Refactor: only call activity functions one time per reroute. This is better for performance because each URL reroute results in less work. (#546)

Maintenance

• update tagline and description (#549)
• Add npm downloads badge (#542)

Patches

• Removing errant copyright text within the license. Single-spa is still MIT license (#432)
• Changing all links to point to updated Github organization name, instead of CanopyTax (#430)

Features

• Support short-circuited, partial rerouting. This occurs when the URL changes in the middle of a single reroute (#529 via @arturovt)
• Add extra properties to PopStateEvents that originate within single-spa - Documentation (#532 via @jamesopti)
• Custom props provided to applications may now be passed in as a function that returns an object - Documentation (#533 via @joeldenning)
• Add new single-spa:before-mount-routing-event fired to the window - Documentation (#534 via @joeldenning)
• New API pathToActiveWhen is exposed as a single-spa export - Documentation (#535 via @joeldenning)

Fixes

• Fix strict mode error where functions were declared inside of if statement. Fixes IE10 issues (#537 via @bloody-ux)

Fixes

• Fix bug in navigateToUrl with URL query comparison #519 (@DuLinRain)

Fixes

• The UMD and System.register builds of single-spa now run in strict mode (#507 via @frehner)
• Fix types for parcels (#510 via @kuitos)
• Add extra information to single-spa:app-change event (#508 via @joeldenning) (see below)

window.addEventListener('single-spa:app-change', evt => {
  console.log(evt.newAppStatuses) // { app1: MOUNTED, app2: NOT_MOUNTED }
  console.log(evt.appsByNewStatus) // { MOUNTED: ['app1'], NOT_MOUNTED: ['app2'] }
  console.log(evt.totalAppChanges) // 2
})

Fixes

• Fix duplicate error codes for single-spa error documentation (#499 via @Sauloxd)
• Typescript: now exporting StartOpts type (#501 via @kuitos)
• Typescript: allow for each lifecycle to be either an array or function (#502 via @kuitos)
• Typescript: correct problem with mountParcel and mountRootParcel typings (#500 via @kuitos)

Fixes

• Updated typescript definitions for start(opts) (#493 @krzyswiatkowski)

Fixes

• Not throwing a second error when unmount fails after mount (#480)

Maintenance

• Upgrade acorn to address security vulnerability (#479)

Features

• Begin mounting applications before others have been loaded (#457 #452 @StyleT)

Maintenance

• Add test for parcels (#439)
• Upgrading dev dependencies to resolve security warnings (#456)
• Removing unused jasmine.json (#455)

Motivation

Full blog post

single-spa@5 is focused on performance and developer experience. The bundle size for single-spa has gone down from ~25kb to ~15kb ungzipped (6kb to 5kb gzipped). We have created new error pages which give in-depth information about console errors, and link to those pages in both development and production builds. We now publish single-spa.dev.js files for easier debugging of single-spa itself. And we have removed all of our deprecated APIs (that have been deprecated and not documented for about two years).
Migration path

99% of single-spa users can simply upgrade to single-spa@5.0.0 without any changes to their code and everything will work exactly as it was before. You'll just benefit from a smaller bundle size and better DX for errors. See the breaking changes below for the few breaking changes that exist.

Breaking changes

• Removing the declareChildApplication and unloadChildApplication apis that have been deprecated for two years. You can use the registerApplication and unloadApplication apis instead. (#390).
• Removing err.name and err.appName from errors passed to single-spa error handlers (#404)

Features

• Switching to "error codes" to communicate what went wrong with single-spa applications. The error codes link to pages such as https://single-spa.js.org/error/?code=1 which give in-depth explanations of what is happening.
• Adding support for warningMillis timeout configuration. This lets you configure or turn off the "application's mount lifecycle did not resolve or reject in 1000 milliseconds" console warnings. (#389)

Fixes

• Fixing link to the new error code documentation pages (#406)
• Fixing error debugging info for parcel-related messages (#407)
• Fix bug where route listeners that throw errors caused other route listeners not to be called (#449)

Performance

• Reducing bundle size with babel/rollup changes (#392)
• Reducing bundle size by removing class syntax (#393)
• Reducing bundle size with various refactors (#396)
• Reducing bundle size by switching from object spread syntax to a manual object assign (#401)

Maintenance

• Adding prettier and speeding up pre-commit (#391)
• Fixing build by upgrading NodeJS version in Travis (#394)
• Updating rollup.config.js to easier way of doing multiple outputs (#403)

Fixes

• Fixed typescript definitions for error handlers (#429 via @tannerlyons)

Patches

• Add version number to a banner comment in output bundles. (#409)
• Improving error messages for parcels (#410)
• Add LOAD_ERROR to typescript definitions (#412)

Features

• Adding new .dev.js builds in addition to .min.js builds, for easier debugging. See example (#347)

Fixes

• Adding LOAD_ERROR status to typescript definitions (#412 #397)

Maintenance

• Upgraded devDependencies (#378)
• Replacing tabs with spaces (#376)

Fixes

• Switched applications in LOAD_ERROR status to retry loading after a period of time, instead of route change (#345)