Release Notes / Version 12.2506.0
Table Of ContentsThe following changes to Public API packages have been made:
Package @coremedia/studio-client.base-models
Deprecations
The module
TimeZones_propertieshas been deprecated. Use the new timeZoneLocalizationRegistry to add localization for time zones instead.
Package @coremedia/studio-client.cap-base-models
Changes
Member
svgIconofIContentTypeLocalizationisnowstring | URLwasstring.getPreferencesStateofPostUploadPreferences}}now returns a {{Promise<boolean | undefined>, in addition to this the type has been sharpened, reflecting that it can also returnundefined(which it could before but it was not stated)
Deprecations
The import for types
ILocalizationandILocalizationWithIconhave been deprecated. Please import the types now from@coremedia/studio-client.base-models
Package @coremedia/studio-client.content-services-api
Deprecations
The methods
getActiveContentandgetOpenedContentsofContentFormServicehave been deprecated. Please utilizeobserve_activeContentandobserve_openedContentsinstead (also check https://rxjs.dev/api/index/function/firstValueFrom).
Package @coremedia/studio-client.interaction-services-api
Removal
The abstract classes
ClipboardandClipboardItemhave been removed in favor of the standard Web API interface (https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API )The class
ClipboardItemImpland the singletonclipboardhave been removed without replacement. To access clipboard data utilize new APIobserveClipboardDataandwriteToClipboardof new package@coremedia/studio-client.interaction-services-toolkitinstead
Move
DataTransferTypeshas been moved to package@coremedia/studio-client.interaction-services-toolkit
Package @coremedia/studio-client.project-services-api
Deprecations
The methods
getActiveProjectandgetOpenedProjectsofProjectFormServicehave been deprecated. Please utilizeobserve_activeProjectandobserve_openedProjectsinstead (also check https://rxjs.dev/api/index/function/firstValueFrom).
Package @coremedia/studio-client.workflow-services-api
Deprecations
The methods
getActiveProcess,getActiveTask,getOpenedProcessesandgetOpenedTasksofWorkflowFormServicehave been deprecated. Please utilizeobserve_activeProcess,observe_activeTask,observe_openedProcessesandobserve_openedTasksinstead (also check https://rxjs.dev/api/index/function/firstValueFrom).
General
The API of many types extending (and including)
RemoteBean has been sharpened. It is now correctly
stated if a property can be null. In addition to
this all properties that are only available if a
RemoteBean has been loaded are now also declared as
undefined. Furthermore, the
isLoaded method has been improved with a type guard
meaning that Typescript
https://www.typescriptlang.org/docs/handbook/2/narrowing.htmlis
now working when checking isLoaded first before
accessing a RemoteBean property.
While improving the types has no impact on runtime code, you might need to consider the undefined / null results in your code in case you have enabled strict null checks in your TypeScript project. The later however, is not relevant for packages build with jangaroo as strict null checks are not enabled per default.
(CMS-27964)
