Meet us at PRINT 19. Chicago, IL. Oct. 3 - 5.

Breaking Changes in 5.0

We actively develop Customer's Canvas API and realize that critical changes may be unacceptable and complicate the update process. When some API elements become inconsistent and inconvenient, we first declare them deprecated, and they work in parallel with the new functionality for a while. In further major releases, we delete such deprecated elements.

This topic describes breaking changes in configuration parameters, markers, and the IFrame API that appear in Customer's Canvas 5.

Changed Parameters in Configuration Files

clientConfig.json

Parameter Name Old Value New Value
defaultAssetSelectWidget "GalleryDialog" "AssetManager"
spellCheckEnabled false true
canvas.shadowEnabled true false
canvas.qualityChangeContainersEnabled false true
canvas.violationWarningButtonsEnabled false true
rendering.hiResOutputColorSpace "rgb" "cmyk"
rendering.hiResOutputInStringPlaceholderHintsEnabled true false
rendering.proofImageFileFormat "png" "jpeg"
rendering.proofImageCropSafetyLine "bleed" ""
rendering.proofImageSafetyLinesEnabled false true
rendering.proofImageInStringPlaceholderHintsEnabled true false
violationWarningsSettings.qualityMeter.qualityLevels.bad 100 50
violationWarningsSettings.shapeViolationsEnabled false true
violationWarningsSettings.textCropViolationWarningEnabled false true
widgets.BottomToolbar.fullWindowButtonEnabled true false
widgets.BottomToolbar.rotateButtonEnabled false true
widgets.BottomToolbar.surfaceSwitch.showThumbnails true false
widgets.ColorPicker.defaultColorSpace "rgb" "cmyk"
widgets.common.fontSize.max 100 1296
widgets.common.leading.max 100 1296
widgets.common.tracking.min -150 -300
widgets.ObjectInspector.aboveCanvasOnSmallScreenEnabled false true
widgets.ObjectInspector.inStringPlaceholderMode "Single" "Multiple"
widgets.ObjectInspector.position "Left" "Right"
widgets.QrCodeDialog.defaultType "QrVCard" "QrUrl"
widgets.TopToolbar.alignButtonsEnabled false true
widgets.TopToolbar.deleteButtonEnabled true false
widgets.TopToolbar.displayAlignButtonsAsDropdown false true
widgets.TopToolbar.displayZOrderButtonsAsDropdown false true

AppSettings.config

Parameter Name Old Value New Value
DesignFolder "\ProductTemplates\designs" "..\assets\designs"
MockupFolder "\ProductTemplates\mockups" "..\assets\mockups"
WatermarkFolder "\ProductTemplates\watermarks" "..\assets\helpers"
DesignImagesFolder "\ProductTemplates\designImages" "..\assets\helpers"
PublicGalleryFolder "\PublicGalleryFolder" "..\assets\images"
UserDataFolder "\UserDataFolder" "..\userdata"
LoadFontListAsPostScriptNames "False" "True"
Hinting "Enabled" "Auto"
SepiaAlgorithm "Standard" "MoreBrown"
SecureModeEnabled "False" "True"

Aurigma.DesignAtoms.config

VectorObjects.config is renamed to Aurigma.DesignAtoms.config and receives the following changes.

Parameter Name Old Value New Value
FontDirectory "\Fonts" "..\assets\fonts"
ColorProfilesDirectory "" "..\assets\ColorProfiles"

Removed Configuration Parameters

clientConfig.json

Parameter Name Recommended Replacement
defaultItemsConfig.<item>.showDeleteButton IItemToolbarPermissionsConfig
defaultItemsConfig.<item>.showEditButton IItemToolbarPermissionsConfig
defaultItemsConfig.<item>.manipulationPermissions.allowProportionalResize IResizeGripsPermissions
defaultItemsConfig.<item>.manipulationPermissions.allowArbitraryResize IResizeGripsPermissions
rendering.proofImageWatermarkEnabled IWatermarkConfig
rendering.proofImageWatermarkFontPostScriptName IWatermarkConfig
rendering.proofImageWatermarkFontSize IWatermarkConfig
rendering.proofImageWatermarkText IWatermarkConfig
widgets.BottomToolbar.surfaceSwitchEnabled ISurfaceSwitchConfig
widgets.GalleryDialog.defaultTab ITabDescriptor
widgets.GalleryDialog.downloadPsdAsImage ITabDescriptor
widgets.GalleryDialog.publicTabEnabled ITabDescriptor
widgets.GalleryDialog.userTabEnabled ITabDescriptor
widgets.GalleryDialog.publicFolderName ITabDescriptor
widgets.GalleryDialog.socialNetworkAppIds ITabDescriptor
widgets.LeftToolbar IToolboxConfig
widgets.ObjectInspector.qualityMeterEnabled IQualityMeterConfig
widgets.ObjectInspector.safetyLineViolationWarningEnabled IViolationWarningsSettingsConfig
widgets.ObjectInspector.regionViolationWarningEnabled IViolationWarningsSettingsConfig
widgets.Toolbox.ButtonAction.ToggleObjectInspector IObjectInspectorConfig
widgets.TopToolbar.zOrderButtonsEnabled IZOrderConfig

Removed Markers

Marker Name Recommended Replacement
<FRT> <RT>
<IAPSF> <IASF>
<MAAR> <MRE>
<MAPR> <MRC>
<PSED> <PAEC>
<TACS> <TACBIU>

Changes in the ObjectModel

Removed Member Recommended Replacement
Customerscanvas.IframeApi.ObjectModel.Product.setUserId() Customerscanvas.IframeApi.RuntimeConfiguration.setUserId()
Customerscanvas.IframeApi.ObjectModel.Product.userId Customerscanvas.IframeApi.RuntimeConfiguration.getUserId()
Customerscanvas.IframeApi.ObjectModel.ISurfacesFromFolder.upMockup Customerscanvas.IframeApi.ObjectModel.IMockupFolders
Customerscanvas.IframeApi.ObjectModel.IMockupTemplateHandlerLegacy Customerscanvas.IframeApi.ObjectModel.IMockupTemplate
Customerscanvas.IframeApi.ObjectModel.IMockupTemplateObject Customerscanvas.IframeApi.ObjectModel.IMockupTemplate
Customerscanvas.IframeApi.ObjectModel.ISafetyLine.leftRightMargin Customerscanvas.IframeApi.ObjectModel.IMarginHV
Customerscanvas.IframeApi.ObjectModel.ISafetyLine.topBottomMargin Customerscanvas.IframeApi.ObjectModel.IMarginHV

New syntax:

  • setMockup(mockup: IMockupTemplate, previewMockups?: IMockupTemplate[], options?: {
        updateRevertData?: boolean;
    }): Promise<Product>;
    

Changes in the Web API

Old Endpoint New Endpoint
~/api/users/{userId}/{stateId} ~/api/users/{userId}/states/{stateId}