Skip to content

Major Version: 5.0.0

Compare
Choose a tag to compare
@jonwinton jonwinton released this 15 Feb 15:05
· 169 commits to master since this release

Changes to the Amphora API are all included in the v5 PR (#505) and include the following:

  • Underscoring of all core routes:
    • /pages --> /_pages
    • /components --> /_components
    • /lists --> /_lists
    • /users --> /_users
    • /uris --> /_uris
    • /auth --> /_auth
  • resolveMedia function is no longer cored to Amphora.
    • If a renderer chooses to handle this/similar functionality then it will need to be handled by that renderer.
    • resolveMedia was really only useful for an HTML renderer which is why this was removed.
  • Renderers now terminate the response if a request would normally have passed to a renderer (#506)
    • The res object is now passed to the renderer as the second argument to the exposed .render function. The state object is still the first argument.
    • As mentioned in the previous bullet, with the removal of resolveMedia, the state object is now missing the media property which had the file paths of the scripts/css files to include. This should only affect amphora-html, but it should be noted.
  • Removed memory leak check in control service. (#508)
    • This was a very specific test that didn't catch all types of memory leaks, only ones related to memoization calls where there was too much variation and inflated the memoize cache.
    • Implementers should choose a memory leak detection method that is best for their setup
  • Removed old publishing API (#507)
    • Implementations should now favor the resolvePublishUrl method. The old resolvePublishing method will no longer work.
  • Removed component service's exported getName function.
    • The clayutils package supports the proper logic for breaking apart component uri strings into their separate parts. It's isomorphic and can help implementations use more consistent logic for parsing all sorts of uri strings. It also supports the underscored routes of this breaking change in the 2.x versions.
  • Removed exported logging service
  • Removed all references to winston and related packages
  • Upped engines npm property to ^8.9.4
  • Upped CircleCI test suite to Node v8.9.4