Release Notes / Version 11.2310
Table Of Contents
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)