Skip to main content
Version: 1.1.0

Changelog

note

We adhere to Semantic Versioning.

Latest Stable Version

Below you find the most recently released stable version that is recommended to be used.

Version 2.0.0

Release date: 2024-02-23

❇️ Added

  • Add new IplabsEditor as a Jetpack Composable that replaces EditorView API-wise
  • Add EditorState class to represent different editor states regarding authentication and termination requests
  • Add EditorEvents interface as a successor of EditorCallbacks to make callbacks better fit the Jetpack Compose environment
  • Add Project class as a common base type of all kinds of projects that can be fed into an IplabsEditor instance
  • Add convenience methods getOptionValueNameById and getOptionValueIdByName to Product to make dealing with option name-value mappings easier
  • Add more keys to the list of texts available for translation
  • Add @JvmField, @JvmOverloads, and @JvmStatic annotations to improve Java-Kotlin interop experience

🔀 Changed

  • Make various subtypes of Project more comprehensible and consistent by renaming ProductConfiguration to NewProject and Project to SavedProject and moving them along with CartProject to package de.iplabs.mobile_sdk.project ⚠ BREAKING
  • Move SavedProjectStorageLocation to package de.iplabs.mobile_sdk.project.storage ⚠ BREAKING
  • Rename localProjectsLocation parameter of IplabsMobileSdk.initialize method to localSavedProjectsLocation ⚠ BREAKING
  • Rename project-related methods of IplabsMobileSdk: retrieveLocalProjects to retrieveLocalSavedProjects, retrieveCloudProjects to retrieveCloudSavedProjects, renameLocalProject to renameLocalSavedProject, renameCloudProject to renameCloudSavedProject, removeLocalProject to removeLocalSavedProject, and removeCloudProject to removeCloudSavedProject ⚠ BREAKING
  • Rename project-related subtypes of OperationResult: LocalProjectsRetrievalResult to LocalSavedProjectsRetrievalResult, CloudProjectsRetrievalResult to CloudSavedProjectsRetrievalResult, LocalProjectModificationResult to LocalSavedProjectModificationResult, and CloudProjectModificationResult to CloudSavedProjectModificationResult ⚠ BREAKING
  • Start migration to Material Design 3
  • Update third party frameworks and dependencies

❌ Removed

  • Remove EditorView from API (succeeded by the new Composable IplabsEditor) ⚠ BREAKING
  • Remove EditorCallbacks interface (succeeded by the new EditorEvents interface) ⚠ BREAKING

Past Versions

The versions listed in this section are still maintained but it is no longer recommended to use them. Use the latest stable version instead whenever possible.

Version 1.3.0

Release date: 2023-07-17

❇️ Added

  • Add support for ip.labs’ Cloud File Storage (CFS) as cloud solution for storing and loading projects
  • Add more keys to the list of texts available for translation

🔀 Changed

  • Update third party frameworks and dependencies

🧰 Fixed

  • Add missing licenses for various editor-related dependencies

Archived Versions

Versions listed in this section have reached end-of-life status and are no longer maintained or supported. Please expand the area below to see all outdated versions. If you are still relying on one of these, it is essential that you update the latest stable version or at least one of the past versions above as soon as possible.

Details

Version 1.2.0

Release date: 2023-05-25

❇️ Added

  • Add interactive augmented reality (AR) preview to editor for wall décor products with usage tutorial and inline help
  • Add enableArForWallDecor flag to EditorConfiguration (set to true by default) to make availability of AR preview configurable
  • Add allowCloudStorage to EditorConfiguration (set to true by default) to control availability of cloud storage for projects
  • Add third party licenses as raw resources
  • Add new translation keys for AR preview and product editor
  • Add listThirdPartyComponentLicenses API method for retrieving third party component licenses as a list of ThirdPartyComponentLicense objects (Android only)

🔀 Changed

  • Update third party frameworks and dependencies
  • IplabsMobileSdk’s initialize method now has an optional cacheLocation parameter, which is required if AR preview support is intended (Android only)
  • Prefix resource names with ipl_sdk_ to avoid collisions with parent application’s resources (Android only)

🧰 Fixed

  • Fix missing doc comment parameter descriptions and typings

Version 1.1.0

Release date: 2023-01-26

❇️ Added

  • Add receiveAnalyticsEvent callback to EditorCallbacks, that triggers every time an event from the editor is captured
  • Add AnalyticsEvent data class to represent captured editor analytics events
  • Make VERSION_NAME of Mobile SDK available as a BuildConfig field, so that e.g. implementing apps can read it (Android only)
  • Add more keys to the list of texts available for translation

🔀 Changed

  • Update dependencies

🧰 Fixed

  • Fix potential memory leak caused by EditorView instances
  • Fix some UI texts not being properly translated

Version 1.0.0

Release date: 2022-10-27

❇️ Added

  • Main API class with initialization call
  • Product portfolio retrieval
  • Order submission
  • Saving and loading of projects
  • User session handling
  • Editor view with event handling callbacks to interact with the surrounding app
  • Customization support (feature set, branding, and translation)