Current
Maintained
release-2024-05
May 2024 Release
https://github.com/livingdocsIO/livingdocs-editor/tree/release-2024-05

To get an overview about new functionality, read the Release Notes. To learn about the necessary actions to update Livingdocs to release-2024-05, read on.

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

Webinar

System Requirements

Suggested

NameVersion
Node20
NPM10
Postgres16
Elasticsearch
OpenSearch		8.x
v2.3.0
Redis7
Livingdocs Server Docker Imagelivingdocs/server-base:20
Livingdocs Editor Docker Imagelivingdocs/editor-base:20
Browser SupportEdge >= 92, Firefox >= 90, Chrome >= 92, Safari >= 15.4, iOS Safari >= 15.4, Opera >= 78

Minimal

NameVersion
Node18
NPM9
Postgres13
Elasticsearch
OpenSearch		7.x
1
Redis6.2
Livingdocs Server Docker Imagelivingdocs/server-base:18.3
Livingdocs Editor Docker Imagelivingdocs/editor-base:18.5
Browser SupportEdge >= 92, Firefox >= 90, Chrome >= 92, Safari >= 15.4, iOS Safari >= 15.4, Opera >= 78

Breaking Changes 🔥

server Operations

Migrate the Postgres Database 🔥

It’s a simple/fast migration with no expected data losses.

# run `livingdocs-server migrate up` to update to the newest database schema
# migration 198-assistants.js
#   creates assistant table and support function
# migration 199-remove-tag-suggestions.js
#   removes tag_suggestions table from the database
# migration 200-assistants-unique=constraint.js
#   adds unique constraint to the assistant table
livingdocs-server migrate up
server/editor Integrations

Migrate iMatrics Tag Suggestion Management 🔥

The tag suggestion management feature has been removed from the Livingdocs Editor and Server in favour of iMatrics’ own tag suggestion functionality. Starting with this release, suggestions are created directly within iMatrics. Customers can find the new management interface in the iMatrics webportal.

Required Actions

Database Migration

Customers should apply the new database migration by running li-server migrate up. This drops the tag_suggestions table.

⚠️ Warning: All data within this table will be irreversibly deleted. Customers must ensure that any open suggestions are migrated to iMatrics’ new suggestion management system. To determine that there are no pending suggestions, they should open the Livingdocs editor at /<project>/tags/imatrics and verify that there are no pending suggestions visible. Alternatively, they can also execute the following database query and confirm that it returns no results.

SELECT * FROM tag_suggestions WHERE status LIKE 'open';

In case there are pending suggestions, customers should either accept or reject them within our interface, provided they are using an older release. Alternatively, they can refer to the iMatrics API documentation on how to programmatically insert them into the new suggestion system.

Customers should remove menu items {liItem: 'tags'} from their project configurations.

iMatrics Webportal

Customers should verify that Concept Management and Concept Suggestions is enabled in their iMatrics account. If this is not the case, they should reach out to iMatrics to have it enabled.

server liServer

Remove internal arrays liServer.onShutdownHandlers and liServer.initializedHooks 🔥

The internal arrays liServer.onShutdownHandlers and liServer.initializedHooks have been removed. Other existing hooks can be used to achieve the same functionality.

Deprecations

server Server Configuration

appConfig.textcount configuration ⚠️

appConfig.textcount configuration has been moved to projectConfig.editorSettings.textCount. The appConfig.textcount configuration will be removed in release-2024-11.

Please migrate text count config from appConfig.textcount to projectConfig.editorSettings.textCount.

editorSettings: {
  ...
  textCount: {
    isEnabled: true,
    timeout: 200,
    showEditableCount: true,
    lineCountFraction: 39.5 // Added in release-2024-05
  }
}
server Desk-net API

Desk-net API function parameters ⚠️

  • Instead of createFromDesknet(projectId, element) please use createFromDesknet({projectId, userId, element}). userId is a new required property.
  • Instead of updateFromDesknet(projectId, documentId, element, opts) please use updateFromDesknet({projectId, documentId, userId, element, linkPublication}). userId is a new required property.
  • Instead of unlinkFromDesknet(projectId, documentId) please use unlinkFromDesknet({projectId, documentId, userId}). userId is a new required property.
server Dashboards

Dashboards of type dashboard ⚠️

Livingdocs provides with Table Dashboards a structured and customizable approach to searching and managing documents. Since release-2022-09, they are the recommended way to create dashboards. Therefore, we are deprecating dashboards of type dashboard and will remove support for them in release-2024-11. Customers using dashboards of type dashboard should migrate to tableDashboard.

server Dashboards

Angular custom dashboard cards ⚠️

As part of our ongoing migration from Angular to Vue, we are deprecating Angular dashboard cards and will remove support for them in release-2024-11. Custom dashboard cards are currently supported in media library dashboards and dashboards of type kanbanBoard, taskBoard, and dashboard (deprecated, see Deprecating dashboards of type dashboard). If you are affected by this change, you should consider using the provided upstream dashboard cards instead. If these do not meet your requirements, please migrate your custom dashboard cards to Vue components.

Features

server/editor New Feature

Livingdocs Assistants 🎁

We are happy to announce the first version of the Livingdocs Assistants Platform. Use it to understand the system and start learning, what can be done.

Livingdocs Assistants are designed to understand the user’s context, namely the current document and focused components. Assistants can generate an array of Document Commands that are then executed server-side. This feature allows for complex document manipulations through a simplified interface, initiated from the editor UI using the Cmd+K (macOS) or Ctrl+K (Windows/Linux) shortcut, where users can find and execute available Assistants.

Please share your ideas for assistants with us, we would love to learn and gather more perspectives.

Register an assistant

  liServer.registerAssistant({
    projectHandles: ['example'], // skip to register it for all projects
    handle: 'generateTitle',
    label: 'Generate Title',
    description: 'Generate an article title',
    iconUrl: 'https://livingdocsio.github.io/livingdocs-design-assets/docs/icons/component-icons/header_simple.svg',
    async assist ({context}) {
      const {document, projectConfig} = context
      const projectHandle = projectConfig.key.projectHandle
      const contentType = document.contentType

      // Apply context validations before executing the command
      if (projectHandle !== 'service' && contentType !== 'article') {
        throw validationError(
          'Cool Title assistant is only available on articles in example project'
        )
      }
      if (!document) {
        throw validationError('Generate Title assistant requires a document')
      }

      const oldTitle = document.metadata.title
      const newTitle = await aiService.generateTitle(document.content)

      // Use Command API compatible commands to modify a document.
      // Return undefined if not applicable.
      return {
        commands: [
          {
            operation: 'setMetadataProperty',
            propertyName: 'title',
            value: newTitle,
            oldValue: oldTitle
          }
        ]
      }
    }
  })
})

The full guide how to implement an assistant can be found here.

editor Teasers

Dynamic Teaser Lists

Dynamic Teaser Lists simplify the management and rendering of teaser lists within pages, providing an efficient solution for semi-automatic page management. This feature reduces the need for custom code compared to other solutions within Livingdocs. Additionally, it supports deduplication across all components in a page, ensuring each teaser is displayed at most once.

Dynamic Teaser Lists can be created with the new li-document-search includes plugin, which supports filtering articles with base filters and display filters. Base filters are always applied and cannot be modified by editors, whereas display filters are rendered in the interface and adjustable by editors. Additionally, sorting order and a limit can be defined, with the latter also being adjustable by editors.

Whenever a new article matches the configured conditions, it is passed to your include’s render function. The conditions are applied on request. Therefore, Dynamic Teaser Lists may contain other teasers over time as new articles match the conditions, without requiring editors to republish the page. Thus, it is recommended to configure your delivery to repeatedly invalidate the cache for such pages and refetch them occasionally from the Composition API to obtain the latest state.

To configure a Dynamic Teaser List, add the li-document-search to the paramsSchema of your include service:

{
  name: 'dynamic-teaser-list-service',
  paramsSchema: [{
    handle: 'teasers',
    type: 'li-document-search',
    config: {
      contentTypes: [],    // optional, shorthand for contentType base filter
      baseFilters: [],     // optional
      displayFilters: [],  // optional
      sort: '',            // optional
      showLimit: true,     // optional, show limit input in UI
      defaultLimit: 3,     // required, default number of included documents
      minLimit: 1,         // optional if showLimit=true, minimum configurable limit in UI
      maxLimit: 5          // required if showLimit=true, maximum configurable limit in UI
    }
  }],
  rendering: {
    type: 'function',
    render (params, context) {
      const content = params.teasers?.values
        .map((document) => ({
          component: 'teaser',
          content: {
            title: document.metadata.title
          }
        }))
      return {content}
    }
  }
}
editor Integrations

Display filter for li-imatrics-nlp-tags

The new display filter for iMatrics enables editors to filter documents on dashboards or in Dynamic Teaser Lists by iMatrics metadata properties.

To set it up, add an indexed metadata property of type li-imatrics-nlp-tags to a content type:

{
  handle: 'imatrics',
  type: 'li-imatrics-nlp-tags',
  config: {index: true}
}

Reference the metadata property in the display filter:

dashboards: [
  {
    displayFilters: [
      {metadataPropertyName: 'imatrics'}
    ]
  }
]
editor Integrations

Display filter for li-retresco

The new display filter for Retresco enables editors to filter documents on dashboards by Retresco metadata properties.

To set it up, add an indexed matadata property of type li-retresco to a content type:

{
  handle: 'retresco',
  type: 'li-retresco',
  config: {index: true}
}

Reference the metadata property in the display filter:

dashboards: [
  {
    displayFilters: [
      {metadataPropertyName: 'retresco'}
    ]
  }
]
editor Search

Document search improvements

In this release we improve the “simple” search strategy based on feedback we received. When searching for document ids we again show the document in the table dashboard as it was in the old search mechanism. We also add the recency boosting from the old search to the simple search and give the option to decide on which field it should be applied.

To configure the recency boosting add the propertyName in the dashboard configs:

{
  handle: 'articles',
  type: 'tableDashboard',
  search: {
    strategy: 'simple',
    recencyBoost: {
      propertyName: 'updated_at'
    }
  }
  // ...
}

Next we are improving language support by using language specific fields which are configured with the correct elasticsearch analyzers. This will also enable to exact match a word when a search term is written in quotes. To enable it you have to set the useLanguageSpecificFields in the elasticindex settings:

{
  elasticIndex: {
    indexNamePrefix: 'li-example',
    indexSettings: {
      useLanguageSpecificFields: true
    },
    // ...
  },
}

We also add the option to configure a german decompounder which will break up compound words. This needs two files a dictionary and a file with hyphenation patterns. Specify the path to those in the settings:

{
  elasticIndex: {
    indexNamePrefix: 'li-example',
    indexSettings: {
      useLanguageSpecificFields: true,
      germanDecompounder: {
        enabled: true,
        dictionary: 'decompounder/dictionary-de.txt',
        hyphenation: 'decompounder/de_DR.xml'
      }
    },
    // ...
  },
}

Note that both the language specific fields and the german decompounder need a recreation of the elastic index.

editor Document State

Manual document status

Many Newsrooms work with a manual status that progresses linearly. The new li-manual-document-status allows to accomadate such usecases by giving the possibility to define a set of statuses along with hex colors.

To configure the manual document status add a metadata property of type li-document-status to a content type:

{
  handle: 'manualDocumentStatus',
  type: 'li-manual-document-status',
  config: {
    index: true,
    placeholder: { en: 'Select status', de: 'Status wählen' },
    statuses: [
      {
        value: 'in-progress',
        label: {en: 'In progress', de: 'In Arbeit'},
        color: '#E04D66'
      },
      {
        value: 'edited',
        label: {en: 'Edited', de: 'Redigiert'},
        color: '#1251CE'
      },
      {
        value: 'ready-for-online',
        label: {en: 'Ready for online', de: 'Fertig für Online'},
        color: '#954FBD'
      },
      {
        value: 'finished',
        label: {en: 'Finished', de: 'Fertig/Schlusskorrigiert'},
        color: '#1FC47A'
      }
    ]
  },
  ui: {
    label: {en: 'Manual status', de: 'Manueller Status'}
  }
}

Reference the metadata property in the display filter:

dashboards: [
  {
    displayFilters: [
      {metadataPropertyName: 'manualDocumentStatus'}
    ]
  }
]
server Integrations

Desk-net Global Integration

It’s now possible to use Desk-Net’s “global” integration with Livingdocs. This links a Livingdocs document directly to the story without having to set a publication platform. The new integration also provides a more flexible way to synchronise data between Livingdocs and Desk-Net (in both directions). In addition, a way of creating Desk-Net elements for existing Livingdocs documents is provided to ease some real-world workflows.

Please read the integration guide or migration guide for further details.

server Integrations

Migration to iMatrics tag management

The tag suggestion feature has been migrated to iMatrics’ own tag suggestion functionality. Starting with this release, tag suggestions are created directly within iMatrics. Customers can find the new management interface in the iMatrics webportal.

Check out the breaking changes for guidance on migrating your tag suggestions.

server Media Library

File import via Public API

For a long time, the Livingdocs Server has supported images and videos import via the Public API. With this release, we also added support for general file imports (e.g. PDF). Now, for all media types, files can be imported into the Livingdocs Media Library from external systems, such as DAMs or similar.

An additional endpoint has been introduced POST api/v1/import/files to support Public API file imports. Similar to images and videos imports, the endpoint requires parameters an array files and systemName as input and returns the media library’s file id.

{
  "systemName": "identifier-for-your-system",
  "webhook": "https://my-domain.com/webhooks/file-import",
  "context": {
    "myIdentifier": "some-identifier-sent-to-the-webhook"
  },
  "files": [
    {
      "url": "https://placekitten.com/800/600",
      "id": "123abc",
      "fileName": "cat",
      "metadata": {
        "caption": "foo"
      }
    }
  ]
}
server/editor New Feature

Document Statistics 🎁

Document Statistics allow users to better understand the shape and completeness of an article by looking at a dashboard. Statistics include the component counts of a document as well as the character count.

The feature builds on top of existing concepts, respectively extends them:

Example Dashboard config excerpt:

{
  handle: 'articles',
  type: 'tableDashboard',
  baseFilters: [
    {key: 'statistics.componentCount.image', exists: true},
    // ...
  ],
  displayFilters: [
    'includedComponents',
    'missingComponents',
    {
      filterName: 'characterCount',
      config: {
        thresholds: [100, 500, 200]
      }
    },
    // ...
  ],
  columns: [
    {
      label: 'Statistics',
      minWidth: 200,
      growFactor: 1,
      priority: 2,
      componentName: 'liTableDashboardCellStatistics',
      componentOptions: {
        characterCount: true,
        componentCount: [
          'title',
          'p',
          'image',
          'image-named-crops'
        ]
      }
    },
    // ...
  ]
}

Vulnerability Patches

We are constantly patching module vulnerabilities for the Livingdocs Server and Livingdocs Editor as module fixes are available. Below is a list of all patched vulnerabilities included in the release.

Livingdocs Server

This release we have patched the following vulnerabilities in the Livingdocs Server:

No known vulnerabilities. 🎉

Livingdocs Editor

This release we have patched the following vulnerabilities in the Livingdocs Editor:

We are aware of the following vulnerabilities in the Livingdocs Editor:

  • CVE-2023-44270 vulnerability in postcss, it affects linters using PostCSS to parse external Cascading Style Sheets (CSS). It is not exploitable in the editor as we don’t load untrusted external CSS at build time.
  • CVE-2023-26116, CVE-2023-26118, CVE-2023-26117, CVE-2022-25869, CVE-2022-25844 are all AngularJS vulnerabilities that don’t have a patch available. We are working on removing all AngularJS from our code and vulnerabilities will go away when we complete the transition to Vue.js.

Patches

Here is a list of all patches after the release has been announced.

Livingdocs Server Patches

  • v251.8.12: chore(example-server): Use getCount for documentPreloader example
  • v251.8.11: chore(queue): Automatically delete processed jobs without calling job.del()
  • v251.8.10: fix(link-directive): Fix link directive html validation to support links without hostname
  • v251.8.9: fix: fix call to assertFunction generator
  • v251.8.8: chore(assistants): Add tests
  • v251.8.7: fix(retresco): Only filter entities in mock API if query is provided
  • v251.8.6: fix(azure-blob-storage): Correctly handle processing errors by propagating to all the streams
  • v251.8.5: fix: Do not load publication references when loading drafts
  • v251.8.4: test(search): Add publication statistics search filter tests
  • v251.8.3: fix(statistics): Decode html entities before counting characters
  • v251.8.2: fix(release-2024-05): Update framework to v29.3.7 (release-2024-05 tag)

Livingdocs Editor Patches

  • v110.13.15: fix(print modal): Layout

  • v110.13.14: fix(create print article): handle overflow for the publication dropdown

  • v110.13.13: fix: don’t fail adding components with include service without paramsSchema

  • v110.13.12: fix(groups): Increment version when updating group members

  • v110.13.11: fix(desknet): Display error notification when story creation fails

  • v110.13.10: fix(kanban-dashboard): Load document state from database on kanban dashboards

  • v110.13.9: fix(permissions): Also extract content types from {not: {key: 'contentType', term: 'regular'}} baseFilters to support permissions correctly

  • v110.13.8: fix(user merge): Spacing

  • v110.13.7: refactor: improve code

  • v110.13.6: fix(images): Fix image upload maxFileSize detection

  • v110.13.5: fix: comment UI labels

  • v110.13.4: fix: delivery links on table dashboard

  • v110.13.3: fix(bundle): don’t show “add to bundle” if no bundle configured

  • v110.13.2: fix(deps): Upgrade @livingdocs/framework@release-2024-05

    Icon Legend

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