Studio Client Unified API: Improved TypeScript Types

The part of Studio Client API that corresponds to CMCC's Unified API in Java (content, workflow, users) has been overhauled to provide more precise TypeScript types. Studio Client TypeScript code has been migrated from ActionScript, where it was not possible to describe callback function signatures and certain complex types (unions, intersections, generic types / type parameters). With TypeScript, now it is. To provide an improved formal description of the API, all vague types like AnyFunction or any have been replaced by more specific types, mostly already given in the textual documentation. This affects the packages @coremedia/studio-client.client-core and @coremedia/studio-client.cap-rest-client. Formally, changing the API to be more specific is a breaking change. But the required callback signatures, array element types and union types have already been documented as text, so if your code adheres these constraints, it is not going to break. Otherwise, only the TypeScript types of your code might have to be adapted, or the new, more precise types may even find hidden bugs in client code that need to be fixed.

(CMS-21089)

ToastManager has been changed to toastService

The access to the ToastManager has been changed. It has been replaced by the global service toastService.

(CMS-20963)

New Rule REST API

With the introduction of the dialog "Folder Properties" a new REST API has been introduced for managing group and content permission via rules. Content.ts and Group.ts support the method getRules now. It returns a remote bean which contains a list of rule remote beans. These ones are displayed either in the Folder Properties dialog or on the rule tab of a user managers group tab.

Follow Section, “New Rule REST API” for upgrade information.

(CMS-20732)

Strict Signature of Content Initializers

The Content Initializer API has been stated more formally precise by specifying the initializer function signature as a TypeScript type (content: Content) => void. This concerns the following methods in IEditorContext (@coremedia/studio-client.main.editor-components/sdk/IEditorContext) and IContentTypeContext (@coremedia/studio-client.cap-base-models/content/IContentTypeContext):

Follow Section, “Strict Signature of Content Initializers” for upgrade information.

(CMS-20652)

Third-Party Update: CKEditor 4 to 4.17.1

CKEditor 4 has been updated to 4.17.1. It is included in @jangaroo/ckeditor4, version 1.1.0.

Follow Section, “Third-Party Update: CKEditor 4 to 4.17.1” for upgrade information.

(CMS-20580)

Studio Client Resource Bundle Changes

In the process of pulling features out of the editor-components module in order to make them available for the new Workflow app, many changes to resource bundles had to be made (these changes are in addition to the changes that happened due to the new content type localization mechanism). As the list is too extensive for a release note, we refer to this link to a Coremedia Help Center article.

(CMS-18728)

Fixed babel Configuration in studio-client

We fixed our internal babel configuration for the studio-client so code is no longer transpiled using the so called "loose" mode. This will cause that the resulting JavaScript code is now more precise regarding ES6 standards than before.

Follow Section, “Fixed babel Configuration in studio-client” for upgrade information.

(CMS-21144)

Master Version Texsts Improved

The description texts above the master version property field have been improved. Existing texts have been removed from the Editor.properties resource bundle. For this reason, the ticket is marked as breaking.

(CMS-20989)