Caveat 🔥
These are the release notes of the upcoming release (pull requests merged to master).
- ℹ️ this document is updated automatically by a bot (pr’s to categorize section)
- ℹ️ this document will be roughly updated manually once a week (put PRs + description to the right section)
- 🔥 We don’t guarantee stable APIs. They can still change until the official release
- 🔥 Integration against the upcoming release (currently
master
branch) is at your own risk
PRs to Categorize
- Fix “Has local changes” for editable teasers
- Drop callback support in group queries
- fix(deps): update opentelemetry (master) (minor)
- fix(deps): update dependency aws-sdk from 2.1345.0 to v2.1347.0 (master)
li-meta-distribution-planning
design polish- fix(deps): update dependency @google-cloud/storage from 6.9.4 to v6.9.5 (master)
- feat(groups): Drop support for serverConfig.policies
- Enforce promises in menu api
- Prevent dashboard drag&drop error
- Add
allowTitleEdit
component option for dashboard main cell - Editable document title in dashboard main cell
- Add
setTitle
patch operation on documents - Sync document content types in afterProjectConfigChange hook
- Rotate npm read token
- Add metadata search in publications
- fix(deps): update dependency exifreader from 4.11.1 to v4.12.0 (master)
- Dashboards: require componentOptions.allowQuickPublish to show publish button in dashboard
- Design/color update
- Replace simple metalman useage with schema API generator
- New title component in document edit toolbar
- Add test case for corrupted image from imago
- Issue Navigation MVP
- fix(deps): update dependency aws-sdk from 2.1343.0 to v2.1344.0 (master)
- feat(content-types): add
displayTitlePattern
to content type schema - Fix undefined session console error in li-comment-mention component
- Return complete document from /documents/:id/parent-issue endpoint
- fix(teasers): allow document drop with any param handle for the reference
- Allow links that can not be parsed by iframely in li-tree
- Dashboards: consider componentOptions.allowQuickPublish for publish state cell
- Archive unused content and media types
- fix(deps): update dependency @livingdocs/framework from 24.13.2 to v24.13.3 (master)
- fix(deps): update dependency wait-on from 6.0.1 to v7 (master)
- Fix: show quick publish on dashboards only when reasonable
- fix(dashboard): allow allowQuickPublish option for publish state dashboard cell
- fix(deps): update dependency moment-timezone from 0.5.41 to v0.5.42 (master)
- fix(deps): update dependency sass from 1.59.3 to v1.60.0 (master)
- fix(deps): update dependency sharp from 0.31.3 to ^0.32.0 (master)
- fix(deps): update dependency aws-sdk from 2.1342.0 to v2.1343.0 (master)
- Add
displayTitlePattern
to content type schema - fix(li-integer): correctly treat 0 value
- Test bundles
- fix(deps): update dependency aws-sdk from 2.1341.0 to v2.1342.0 (master)
- Fix support for arrays in draft query sort option
- Buy-In: improve wording
- Fix/Bundle-Thumbs
- fix(deps): update dependency aws-sdk from 2.1339.0 to v2.1341.0 (master)
- Improve postgres transaction error handling
- Only query configured content types
- fix(deps): update dependency webpack from 5.76.2 to v5.76.3 (master)
- Wait for correct publish event in publication test
- Feat/Toolbar
- Show ldNotify message for bundle actions
- Improve bundle dashboard cells
- fix(deps): update dependency fastify from 4.14.1 to v4.15.0 (master)
- Don’t render hidden context-menu actions
- Make the job queue waitNext more reliable
- Fix redis xtrimdelivered
- Bundle panel in article metadata
- Support expectedOrActualPublicationDate filters in the search
- Apply menu list filters for table dashboards
- fix(deps): update opentelemetry (master) (patch)
- fix(deps): update dependency aws-sdk from 2.1338.0 to v2.1339.0 (master)
- fix(deps): update dependency fs-extra from 11.1.0 to v11.1.1 (master)
- Do not close postgres pool clients on query errors
- fix(document selection): ensure filters are applied when using legacy dashboards
- Don’t hide table dashboard flyouts on mouseleave
- Ignore test files in metadata plugin loader
- fix: add favicon.ico and apple-touch-icon
- Hide download button when no crops are available
- Fix content type changes on documents
- fix(deps): update dependency webpack from 5.76.1 to v5.76.2 (master)
- fix(deps): update dependency mini-css-extract-plugin from 2.7.3 to v2.7.5 (master)
- fix(deps): update dependency sass from 1.59.2 to v1.59.3 (master)
- fix(deps): update dependency style-loader from 3.3.1 to v3.3.2 (master)
- fix(deps): update dependency exifreader from 4.11.0 to v4.11.1 (master)
- fix(deps): update dependency aws-sdk from 2.1337.0 to v2.1338.0 (master)
- Don’t show metadata button for legacy publication
- Remove support of .documents and .publications properties on search results
- fix(deps): update babel (master)
- Enable Publish Control for contentType
page
in projectmagazine
- Fix li-datetime filter date parsing
- Search DSL
- Support caching for byIds dataloader
- Fix/Scrollbar Issues
- fix(creation flow): Allow content type boxes to text wrap their labels
- Fix finite products config
- Issue navigation
- fix(deps): update dependency @fastify/reply-from from 9.0.0 to v9.0.1 (master)
- Remove app-level unnecessary scrollbar
- fix(deps): update dependency @livingdocs/framework from 24.13.1 to v24.13.2 (master)
- fix(display filter): ensure custom vue display filters get the config object
- fix(deps): update dependency @fastify/reply-from from 8.4.3 to v9 (master)
- Replace Generic error (5XX) used for Password verification with
validationError
- Show distribution toolbar action on bundles
- Also anonymise in changes calls
- fix(deps): update dependency aws-sdk from 2.1334.0 to v2.1335.0 (master)
- fix(create): correctly check if contentType is on defaultChannel
- Add existing documents to bundle
- Fix Desk-Net Schedule automatic placement errors due to schedule properties
- fix(deps): update opentelemetry (master) (minor)
- fix: update framework version
- fix: bump framework version
- fix(deps): update dependency @livingdocs/framework from 24.13.0 to v24.13.1 (master)
- fix(deps): update dependency @opentelemetry/api from 1.4.0 to v1.4.1 (master)
- Fix: contentType displayFilter works correctly with contentTypes not from the defaultChannel
- Remove document from bundle
- Shows scheduled doc tooltip
- Create and add documents to bundle
- Use yyyy-MM-dd format date query parameter for Distribution Planning Schedule fixed date request
- fix: remove 2nd line of buy-in empty state
- fix(deps): update dependency webpack from 5.75.0 to v5.76.1 (master)
- chore(deps): update dependency eslint from 8.35.0 to v8.36.0 (master)
- Allow dashboard request to exclude revision content
- Don’t load document content in table dashboards
- fix(deps): update dependency aws-sdk from 2.1331.0 to v2.1332.0 (master)
- Fix Task List
- Add
li-bundled-documents
metadata plugin - Bundle panel with empty state
- fix(deps): update opentelemetry (master) (minor)
- Upgrade sharp to fix Premature close error
- Transform pitch to bundle
- Handle pitch and bundle independent of publish control
- Deprecate Identifier
- Update framework
- fix(deps): update dependency jose from 4.12.2 to v4.13.1 (master)
- fix(deps): update dependency cloudinary from 1.34.0 to v1.35.0 (master)
- fix(deps): update dependency @google-cloud/storage from 6.9.3 to v6.9.4 (master)
- fix(deps): update dependency lru-cache from 7.17.0 to v7.17.2 (master)
mediaIndex
normalisation, renamed toindexing
- Dynamic metadata for Publication indexing
- Feat/Component Icons V2
- Feat/Component Icons V2
- Default Editor configuration
- Fix flashing List Assignment
- fix(deps): update dependency fastify from 4.13.0 to v4.14.0 (master)
- fix(deps): update dependency fastify from 4.13.0 to v4.14.0 (master)
- Dashboards: correctly apply stored display filter states on initial search
- Fix distribution planning date range queries to use newsroom timezone
- Add
li-buy-in
planning system guard - Fix typos in localisation
- Fix/distribution flyouts
- Remove some internal yargs apis
- Fix
li-meta-integer
display filter error - Data Migration Log Improvement
- Refactoring: Document Migration V2
- Fix broken display filters in legacy dashboards
- Update
@livingdocs/framework
to include fix for imgIX URL generation - Provides a server configuration to remove leading directory for ImgIX service
- Don’t show unconfigured content types in distribution planning table dashboard
- Handle import and webhook jobs immediately instead of using the waiting logic that requires less redis connections
- fix(deps): update dependency axios from 0.27.2 to v1 (master)
- Make foreign key constraints deferrable
- Restrict maximum postgres query parameters
- Fix axios 1 http querystring compatibility
- Fix renovate platformAutomerge
- fix(deps): update dependency open from 8.4.1 to v8.4.2 (master)
- fix(deps): update dependency pino from 8.10.0 to v8.11.0 (master)
- Fix renovate platformAutomerge
- fix(deps): update dependency lru-cache from 7.16.1 to v7.16.2 (master)
- fix(deps): update dependency @azure/storage-blob from 12.12.0 to v12.13.0 (master)
- Fix query performance with big tables
- Fix: Publish Control Button changes state after publish / draft creation
- Fix/distribution dashboard layout
- Fix queue waiting delay when a queue did not return results
- multipleServices apply defaultParams
- Emit publication.update event for publishControl changes
Attention: If you skipped one or more releases, please also check the release-notes of the skipped ones.
Webinar
- Feature Webinar Recording: TODO
- Feature Webinar Documentation: TODO
- Dev Webinar Recording: TODO
- Dev Webinar Slides: TODO
- Release Newsletter Subscription
System Requirements
Suggested
TODO
Minimal
TODO
Highlights
Document Access Control
TODO: Description
Synced Table Dashboards
TODO: Description
Planning System (Bundles)
TODO: Description
Working Title
TODO: Description
Publication/Draft Index
TODO: Description
Advanced Search Filters Foundation
TODO: Description
Home Screen - Part 2
TODO: Description
Display Filters ListV2 with OR combination
TODO: Description
Issue Management - Navigation
TODO: Description
Metadata Preview
TODO: Description
Concurrent License Model: Billing Report
TODO: Description
i18n - Editor available in German
TODO: Description
Microsoft Teams Integration
TODO: Description
Breaking Changes 🔥
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 scheme
# migration 184-increase-webhook-handle-length.js
# limit webhook handle to 50 characters
# migration 185-li-get-leaf-of-revision-history.js
# add psql function li_get_leaf_of_revision_history
livingdocs-server migrate up
Drop support for node v14
🔥 Drop support for node 14, use node v18 instead.
Drop support for Redis < v6.2
🔥 The minimal required Redis version is v6.2.
Upgrade to elasticsearch client v8
🔥 The response structure changed in the new client. If you have custom code that accesses elasticsearch, you’ll need to update it accordingly:
- const {body} = await elasticsearchClient.search({
+ const body = await elasticsearchClient.search({
index: 'li-documents',
q: `document.id:${this.doc.id}`
})
Please see the examples of elasticsearch how to use it: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/get_examples.html
🔥 The elasticsearch client configuration changed slightly. Please consult the elasticsearch client configuration documentation: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/basic-config.html
search: {
elasticsearchClient: {
node: 'https://127.0.0.1:9200/',
auth: {username: 'admin', password: 'admin'},
- ssl: {rejectUnauthorized: false}
+ tls: {rejectUnauthorized: false}
}
},
Stricter search queries
🔥 Filters on unavailable properties throw an error.
🔥 Elasticsearch
exists
queries on objects not supported anymore. Please use a specific sub-property instead.e.g. To filter for documents that have no category assigned, you need to use
category.reference.id
instead ofcategory
in the editor search filter:{ id: 'without-category', label: 'Without category', type: 'metadata', - key: 'category', + key: 'category.reference.id', value: {exists: false} }
References: Server PR
Don’t expose error_details in 5xx response
🔥 5XX responses will no longer contain body.error_details
object, still the whole error response will be logged.
References: Server PR
Remove metadata plugin li-media-language
🔥 Remove metadata plugin li-media-language
, use li-metadata-translations
instead.
References: Server PR
Remove deprecated document.path
Since a long time we deprecated the DB property documents.path
, because there is no real feature behind that property.
🔥 contentTypes[].editor.deliveryLinks
do not support:path
placeholder
🔥 editor model draft.path
is not accessible anymore
References: Server PR
Support removal of metadata properties by assigning null
🔥 Before this change, assigning null values resulted in a metadata schema error. Now it’s accepted and it removes the metadata property. Therefore it’s not possible anymore to save the value null as metadata property value.
// before
metadata.myField = null // throws
// now
metadata.myField = null // delete metadata.myField
References: Server PR
Mandatory project_id in documentApi.find
🔥 Make project_id
mandatory in documentApi.find
References: Server PR
Fix firstPublicationDate to documents table (Post Deployment) 🔥
This script was backported to release-2022-11, so it has been added again for release-2023-05 in case anyone missed it. If you already ran the script with the previous release upgrade you do not need to run it again.
If you have unpublished a document while running release-2022-07 or release-2022-09 then you may have inaccurate values for the document.systemdata.firstPublicationDate
. Below is a comparison of the change in the four most recent versions:
First publish:
release-2022-07 and release-2022-09: Set firstPublicationDate
release-2022-05 and release-2022-11: Set firstPublicationDate
Republish while published:
release-2022-07 and release-2022-09: Keep firstPublicationDate
release-2022-05 and release-2022-11: Keep firstPublicationDate
Unpublish:
release-2022-07 and release-2022-09: Remove firstPublicationDate
release-2022-05 and release-2022-11: Keep firstPublicationDate
Republish after unpublish:
release-2022-07 and release-2022-09: Set firstPublicationDate
release-2022-05 and release-2022-11: Keep firstPublicationDate
Essentially the old behaviour and the new “fixed” behaviour is to set firstPublicationDate
once and never modify it. This property will still exist even when the document is unpublished. For release-2022-07 and release-2022-09 the difference in behaviour was that the firstPublicationDate
would be cleared on unpublish and set again at the next publish.
If you would like to correct the firstPublicationDate
property for all of your articles you can run:
node ./node_modules/@livingdocs/server/db/manual-migrations/009-fix-first-publication-date.js
This script performs the following actions:
- Check that
first_publication_id
has been set (same as the script 007-populate-first-publication-data.js) - Move
firstPublicationDate
fromdata
todata.publishControl
- Remove
data.firstPublicationDate
- If
firstPublicationDate
is not set then use the value from the first publication - If
firstPublicationDate
is set then use the value from the first publication when the first publication is older
It is highly recommended that you run this script because it is performing a data migration as well as fixing the values.
References: Server PR
Deprecations
Deprecate Dashboard Display Filters
These Dashboard Display Filters get deprecated:
coreApi.searchFilters.register
coreApi.searchFilters.registerList
coreApi.searchFilters.registerAngularComponent
Update the deprecated filter to the supported Display Filters from the core.
- Named Filters
- Metadata Filters
- ListV2 Filters
If you can’t handle your requirements with core filters it’s best to contact your Customer Solutions manager to get inputs for solutions (one option is to create your custom Vue component, but that should be prevented whenever possible)
Breaking Change: release-2023-03
References: Editor PR
Other Changes
Features
- Load drafts in includes
- Add server config ‘httpServer.showStackTraces’
- Support Dailymotion for oEmbed include
Improvements
Bugfixes
- Publish screen back button returns to custom data record dashboard after create
- Handle focal point in metadata forms
- Fix date sort order on users admin screen
Patches
Here is a list of all patches after the release has been announced.
Livingdocs Server Patches
Livingdocs Editor Patches
Icon Legend
- Breaking changes: 🔥
- Feature: 🎁
- Bugfix: 🪲
- Chore: 🔧