Contentstack App SDK v2.0.0 Migration Guide

App SDK v2.0.0 introduces breaking changes that improve the structure and enhance plugin development flexibility. Follow the instructions to transition to the updated version.

If your application uses the metadata module to manage app metadata, update your code to handle the new response structure.

The following methods now return a simplified format in version 2.0.0:

• createMetaData()
• retrieveMetaData()
• retrieveAllMetaData()
• updateMetaData()
• deleteMetaData()

Here's a comparison of the old and new response structures:

Older Response (Version 1.x):

{
  data: {
    metadata: {} // Actual metadata response to be returned,
  },
  origin: app.contentstack.com, // origin where the app is running
  source: global{} // Source information
}

Newer Response (Version 2.0.0):

{
  "metadata": {} // Actual metadata response to be returned,
}

If your app uses the EntryFieldLocation or FullscreenAppWidget properties to manage field modifiers or full-page applications, update these references to match the new names in version 2.0.0:

Replace appSDK.location.EntryFieldLocation with appSDK.location.FieldModifierLocation.

Replace appSDK.location.FullscreenAppWidget with appSDK.location.FullPage.

In earlier versions of the App SDK, the _extension property was available after initialization. Version 2.0.0, replaces this with _uiLocation. Update your code as follows:

Replace appSdk._extension with appSdk._uiLocation.

Example:

ContentstackAppSDK.init((appSdk) => {
  // Previous version
  appSdk._extension; // No longer available

  // Updated version
  appSdk._uiLocation; // Instance of the UiLocation
});

The following table summarizes key changes introduced in App SDK v2.0.0. Use this as a quick reference when updating your plugin or extension code:

These migration steps help you transition smoothly to App SDK v2.0.0. For any questions, contact Contentstack Support.