Search
Loading...
Skip to content
Back to all releases

Version v1.34.0 Changelog August 31, 2024

Breaking Changes

  • Editor/Web, Engine/Web: Configuration options, APIs and types that have been deprecated in Version 1.13 have been removed.

    The ConfigTypes namespace has been removed and the following type definitions in it have been removed without replacement since they are not used anymore:

    • ConfigTypes.Scene
    • ConfigTypes.Page
    • ConfigTypes.ColorDefinition
    • Configtypes.ColorPaletteDefinition
    • ConfigTypes.Variables
    • ConfigTypes.VariableDefinition
    • ConfigTypes.Callbacks
    • ConfigTypes.TemplateDefinition
    • ConfigTypes.Preset
    • ConfigTypes.Presets
    • ConfigTypes.AssetSources

    Other types in the ConfigTypes namespace might still be used and can be imported directly from @cesdk/engine or @cesdk/cesdk-js:

    • ConfigTypes.Color as PaletteColor
    • Asset source related types
      • ConfigTypes.QueryData as AssetQueryData
      • ConfigTypes.AssetResult as AssetResult
      • ConfigTypes.AssetsQueryResult as AssetsQueryResult
      • ConfigTypes.AssetSource as AssetSource when working with the Asset API
    • ConfigTypes.HexColorString as HexColorString
    • ConfigTypes.PageFormatDefinition as PageFormatDefinition from @cesdk/cesdk-js
    • ConfigTypes.TypefaceDefinition as TypefaceDefinition (deprecated, use the Asset API to define custom typefaces instead)

    The following Settings have been removed. For detailed instructions on how to migrate away from them, consult the Migrating to v1.13 guide

    • config.scene
    • config.page
    • config.assetSources
    • config.presets.colors
    • config.presets.colorPalettes
    • config.presets.pageFormats
    • config.variables
    • config.callbacks.logger
    • config.initialImageURL
    • config.initalSceneMode
    • config.initialSceneString
    • config.initialSceneURL
    • config.presets.templates: Since version 1.12 this setting has been deprecated. See the Adding Templates guide for instructions on how to use the AssetAPI to add templates.
    • config.defaultFont: Since version 1.13 it has been deprecated in the Engine, but not in the Editor. In the Editor this setting has been ignored since version 1.26. There is no replacement for this setting.

    Additionally the following types and APIs have changed and might require adjustments:

    • The CreativeEditorSDK.init method has been removed. Use CreativeEditorSDK.create instead
    • The CreateConfiguration type exported from @cesdk/cesdk-js has been removed. Use Configuration instead.
    • CreativeEditorSDK.setVariableDefinitions has been removed. Use the Variable API instead.

  • Editor/Android: onClose callback now contains an optional Throwable parameter in the composable functions of all the solutions. If the value of this parameter is not null, it means that the editor is closed due to an error. The value is propagated from EditorEventHandler.sendCloseEditorEvent. Unless custom types are sent to this function, throwable is always going to be either an EditorException or EngineException.

Non Breaking Changes

  • Engine: Fixed content-aware resize to not result in a distorted image if a page with an image fill is resized.
  • Editor: Added drag selection for easy selection of multiple elements.
  • Engine/Swift: New functions to load a scene from an archive, and to save and load block to an archive.
  • Engine/Swift: Add getState and setState to manually set the state of a block to .pending, .error or .ready. Add onStateChanged to be notified of a block’s change of state.
  • Engine/Android: Add getState and setState to manually set the state of a block to Pending, Error or Ready. Add onStateChanged to be notified of a block’s change of state.
  • Editor/iOS: Fixed some videos that played back audio slower than expected.
  • Engine: Use a more common time scale for the audio track of exported videos.
  • Editor/Web: Fixed an issue where some built-in Inspector Bar Components did not react immediately to Feature API calls.
  • Editor/Web: Fix fill panel overlapping other panels
  • Editor/Web: Preview mode is being exited on applying new template
  • Editor/Web: Fixed that multi-selecting several pages causes the editor to automatically scroll and wrong pages being selected.
  • Editor/Web: Fix elements being selected during gesture based scrolling via touch input
  • Editor/Web: Undo/redo does not change zoom level anymore
  • Editor/Web: Pasting elements now adds an undo/redo history step
  • Editor: Introduced new control gizmo settings blockScaleDownLimit to control how small a block can be resized with the gizmos or with touch gestures.
  • Editor: Fixed the dimming overlay when editing the crop of an page with an image fill to only dim the part out of the page.
  • Editor/Web: Select all elements after duplicating multiple elements
  • Editor: Multi-selection of elements across different pages is disabled to prevent unexpected editing behavior.
  • Editor: The clampCameraCommand skips clamping while the page size or position is being edited with user interaction. This prevents that the camera is changed, while editing the page with drag handles or gestures.
  • Editor/Web: Fix canvas menu position on multiselection
  • Engine: Fixed the onClick subscription to send notifications for clicks or taps that select elements that were previously not selected. In some cases, these events were not sent.
  • Engine: Fix a false positive video encoding time out error that can be encountered due to slow resource fetching.