Migrate from v0.2.x to v0.3.x

There are a couple fields from v0.2.x which changed in v0.3.x. This guide will walk you through what the changes are and how to update your usage of the SDK for v0.3.x.

config

config has been removed. It is now possible to set many of the options that were in the config on the Customizations page. You may still pass in overrides at runtime with the SDK by using the customizationOverrides property. In many cases the properties are the same, however some properties changed:

Old propertyNew property
blockImportIfErrorsIs now handled by importErrorUX. true corresponds to "blockIfErrors" and false corresponds to "promptIfErrors"
skipExportDataIs now handled by importConfig. If using, set to:
{ type: "local", metadataOnly: true }
contentOptions.upload.uploader.headeruploaderHeaderText
contentOptions.upload.uploader.subheaderuploaderSubheaderText
contentOptions.upload.infoSidebaruploaderShowSidebar
contentOptions.upload.infoSidebar.hideInfoBanneruploaderShowSidebarBanner
contentOptions.upload.infoSidebar.infoBannerTextuploaderSidebarBannerText
contentOptions.upload.infoSidebar.displayTemplateColumnsuploaderSidebarDetails

webhookKey

webhookKey has been removed. It has been replaced with importConfig which allows you to specify both the type of import you want to perform on completion and any settings you were using before.

If you were using webhookKey replace it with importConfig with the value being:

{
  type: "webhook"
  key: YOUR_WEBHOOK_KEY
}