Attention: If you skipped one or more release, please also check the release-notes of the skipped ones.

Repositories

This release consists of the following new versions of the livingdocs-server and the livingdocs-editor:

Livingdocs Server

How to require the server in your package.json:

"dependencies": {
  "@livingdocs/server": "70.9.4",
}

• Link to the release branch: https://github.com/livingdocsIO/livingdocs-server/tree/release-2018-05

Livingdocs Editor

How to require the editor in your package.json:

"dependencies": {
  "@livingdocs/editor": "30.3.8",
}

• Link to the release branch: https://github.com/livingdocsIO/livingdocs-editor/tree/release-2018-05

Highlights

New API for channel configurations 🔥 🎁

Added li-channel-configs feature.

The feature is disabled by default. To activate it add the following config:

  channelConfigs: {
    enabled: true
  }

Breaking change:

// the return value `renderConfig` has changed:
channelApi.getRenderConfig({channelId, contentType}, (err, renderConfig) => {})

• property rename: renderConfig.renditionsConfig -> renderConfig.renditions

• property added: renderConfig.path // absolute path to the render config. Can be required.

• new methods: renderConfig.isEmpty() and renderConfig.getAvailableRenditions()

Also requiring the render config is now delayed. Previously we would require the path which points to the render config file when initialising the projects feature. Now it is required at runtime whenever it is used. This means we do not update the loaded config anymore and it remains serialisable.

server #1875

Extend responses for the seed API 🔥 🎁

Breaking change: The “seedDocuments” method does no longer just return an array of document versions, but an object with:

type SeedDocumentsRes = {
  documents: DocumentVersion[],
  documentsBySeedId: { [seedDocumentId:number]: DocumentEntity }
}
const {documents: documentVersions, documentsBySeedId}: SeedDocumentsRes = await seedApi.seedDocuments(params, seedDocumentsData)

This information turned out to be very useful and should be included in the return values.

server #1921

Replace angular-ui-router with @uirouter/angularjs 🔥 🔧

Breaking change: https://ui-router.github.io/guide/ng1/migrate-to-1_0

editor #1842

Disable backwards-compatibility feature for component bindings. 🔥 🔧

Breaking change: Check if your (downstream) editor creates directives/components e.g. app.component/app.directive and check/move bindings from the controller constructor to $onInit. More details you can find in the migration guide

editor #2027

Enable single sign-on with external providers 🎁

It adds the possibility to signup (user registration) and signin (user authentication) using external OAuth 2 providers such as Github, Google or Facebook. When signining a user and its own project are created.

server #1782 editor #1913

Database cleanup 🎁

It provides a tool to truncate the history (revision/metadata/publication) by user per document.

server #1736

Other Changes

• CLI commands to import and delete projects. server #1925 🎁
• Extend filtering for the user and project API. server #1915 🎁
• Router allows query strings on paths. server #1934 server #1935🪲
• Extend responses for the menu API. server #1933 🎁
• Extend content-type configuration to include the editor’s UI. server #1937 🪲
• Enables menu seeding. server #1923 🎁
• Add a hook for the document seeding API so that documents can be adjusted before being updated. server #1941 🎁
• Add Single sign-on with external providers such as Github, Google or Facebook. server #1782 editor #1913 🎁
• Grunt task to create a user with project builders. server #1943 🎁
• Improve compatibility the Safari browser. server #1945 🪲
• Allow to skip a migration based on the migration file callback. server #1951 🎁
• Pass some systemdata to migration files. server #1956 🎁
• Simplify project administration pages editor #1976 🎁
• Improve error and unauthorize pages. editor #2001 🎁
• Configure visibility of the list assignment in the publish screen. editor #2002 🎁
• UI improvments on the tasks side panel of the editor. editor #1915 🪲
• Centralize Entry Point Logic in the welcome page. editor #2011 🪲
• Enable creation of a start page for users after login and signup. editor #2029 🎁
• Add textarea form to metadata forms. editor #2030 🎁
• Add new 1/6em white space. editor #2035 🎁

Icon Legend

• Breaking changes: 🔥
• Feature: 🎁
• Bugfix: 🪲
• Chore: 🔧