Upgrade Notes

  • 5 minutes to read

We actively develop the 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.

Design Editor 6 Upgrade Notes

When upgrading Design Editor 5 to 6, you will face breaking changes in configuration parameters, markers, and the Web API.

Bleed Zone and Print Area Size

Starting from version 5.33, we have changed the way we define the bleed zone and print area size. Earlier, if you wanted to create a 3.5x2" business card with 1/8" bleed, you created a 3.75x2.25" design and put a safety line inside it. But now, when you create a 3.5x2" design, the bleed zone will expand outside the design.

Defining the bleed zone.

After upgrading to version 6, you may run into a problem when the size of the product is not what you expect, and unnecessary safety lines may also appear. If you encounter this, you can either rework the design and change the Bleed and Slug settings, or enable the old behavior. In the latter case, set LegacyIdmlBleedParsingEnabled to True in Aurigma.DesignAtoms.config.

For more details, refer to Importing the bleed zone from InDesign.

Changed Parameters in Configuration Files

clientConfig.json

Parameter Name Old Value New Value
watermark.text.fontSettings"ArialMT""Roboto-Regular"

AppSettings.config

Parameter Name Old Value New Value
FontSubstitutionEnabled"True""False"
SubstitutionFontPostScriptName"ArialMT""Roboto-Regular"
DefaultFontPostScriptName"ArialMT""Roboto-Regular"

Removed Configuration Parameters

AppSettings.config

Parameter Name An Alternative
ParagraphTextEnabledNot applicable

clientConfig.json

Parameter Name An Alternative
arbitraryResizeForImageItemEnabledIResizeGripsPermissions
defaultAssetSelectWidgetNot applicable
newImageNamedefaultItemsConfig.image.name
canvas.snapLines.enabledcanvas.snapLines.{type}.enabled
canvas.snapLines.colorcanvas.snapLines.{type}.color
canvas.snapLines.tolerancecanvas.snapLines.{type}.tolerance
canvas.ZoomStepcanvas.zoom
widgets.BottomToolbar.snapLinesCheckboxEnabledwidgets.BottomToolbar.snapLines{type}CheckboxEnabled
widgets.ColorPicker.defaultColorSpacewidgets.ColorPicker.colorSpace
widgets.ColorPicker.availableColorSpacesNot applicable
widgets.ColorPicker.paletteIPaletteSection

Removed Markers

Marker Name An Alternative
<DPH>Dynamic Image API

Renamed parameters in the Web API 6

Endpoints

POST ~/api/Preview/GeneratePreview

POST ~/api/HiRes/GenerateHiRes

Parameters in the request payload

Old Parameter New Parameter
previewOptions.width previewOptions.maxWidth
previewOptions.height previewOptions.maxHeight

Attributes in the response object

Old Attribute New Attribute
ProofImageUrls proofImageUrls
StateId stateId
HiResUrls hiResUrls

Design Editor 5 Upgrade Notes

When upgrading Design Editor 4 to 5, you will face breaking changes in configuration parameters, markers, and the API.

Changed Configuration Parameters

clientConfig.json

Parameter Name Old Value New Value
defaultAssetSelectWidget"GalleryDialog""AssetManager"
spellCheckEnabledfalsetrue
canvas.shadowEnabledtruefalse
canvas.qualityChangeContainersEnabledfalsetrue
canvas.violationWarningButtonsEnabledfalsetrue
rendering.hiResOutputColorSpace"rgb""cmyk"
rendering.hiResOutputInStringPlaceholderHintsEnabledtruefalse
rendering.proofImageFileFormat"png""jpeg"
rendering.proofImageCropSafetyLine"bleed"""
rendering.proofImageSafetyLinesEnabledfalsetrue
rendering.proofImageInStringPlaceholderHintsEnabledtruefalse
violationWarningsSettings.qualityMeter.qualityLevels.bad10050
violationWarningsSettings.shapeViolationsEnabledfalsetrue
violationWarningsSettings.textCropViolationWarningEnabledfalsetrue
widgets.BottomToolbar.fullWindowButtonEnabledtruefalse
widgets.BottomToolbar.rotateButtonEnabledfalsetrue
widgets.BottomToolbar.surfaceSwitch.showThumbnailstruefalse
widgets.ColorPicker.defaultColorSpace"rgb""cmyk"
widgets.common.fontSize.max1001296
widgets.common.leading.max1001296
widgets.common.tracking.min-150-300
widgets.ObjectInspector.aboveCanvasOnSmallScreenEnabledfalsetrue
widgets.ObjectInspector.inStringPlaceholderMode"Single""Multiple"
widgets.ObjectInspector.position"Left""Right"
widgets.QrCodeDialog.defaultType"QrVCard""QrUrl"
widgets.TopToolbar.alignButtonsEnabledfalsetrue
widgets.TopToolbar.deleteButtonEnabledtruefalse
widgets.TopToolbar.displayAlignButtonsAsDropdownfalsetrue
widgets.TopToolbar.displayZOrderButtonsAsDropdownfalsetrue

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 Parameters

clientConfig.json

Parameter Name Recommended Replacement
defaultItemsConfig.<item>.showDeleteButtonIItemToolbarPermissionsConfig
defaultItemsConfig.<item>.showEditButtonIItemToolbarPermissionsConfig
defaultItemsConfig.<item>.manipulationPermissions.allowProportionalResizeIResizeGripsPermissions
defaultItemsConfig.<item>.manipulationPermissions.allowArbitraryResizeIResizeGripsPermissions
rendering.proofImageWatermarkEnabledIWatermarkConfig
rendering.proofImageWatermarkFontPostScriptNameIWatermarkConfig
rendering.proofImageWatermarkFontSizeIWatermarkConfig
rendering.proofImageWatermarkTextIWatermarkConfig
widgets.BottomToolbar.surfaceSwitchEnabledISurfaceSwitchConfig
widgets.GalleryDialog.defaultTabITabDescriptor
widgets.GalleryDialog.downloadPsdAsImageITabDescriptor
widgets.GalleryDialog.publicTabEnabledITabDescriptor
widgets.GalleryDialog.userTabEnabledITabDescriptor
widgets.GalleryDialog.publicFolderNameITabDescriptor
widgets.GalleryDialog.socialNetworkAppIdsITabDescriptor
widgets.LeftToolbarIToolboxConfig
widgets.ObjectInspector.qualityMeterEnabledIQualityMeterConfig
widgets.ObjectInspector.safetyLineViolationWarningEnabledIViolationWarningsSettingsConfig
widgets.ObjectInspector.regionViolationWarningEnabledIViolationWarningsSettingsConfig
widgets.Toolbox.ButtonAction.ToggleObjectInspectorIObjectInspectorConfig
widgets.TopToolbar.zOrderButtonsEnabledIZOrderConfig

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.userIdCustomerscanvas.IframeApi.RuntimeConfiguration.getUserId()
Customerscanvas.IframeApi.ObjectModel.ISurfacesFromFolder.upMockupCustomerscanvas.IframeApi.ObjectModel.IMockupFolders
Customerscanvas.IframeApi.ObjectModel.IMockupTemplateHandlerLegacyCustomerscanvas.IframeApi.ObjectModel.IMockupTemplate
Customerscanvas.IframeApi.ObjectModel.IMockupTemplateObjectCustomerscanvas.IframeApi.ObjectModel.IMockupTemplate
Customerscanvas.IframeApi.ObjectModel.ISafetyLine.leftRightMarginCustomerscanvas.IframeApi.ObjectModel.IMarginHV
Customerscanvas.IframeApi.ObjectModel.ISafetyLine.topBottomMarginCustomerscanvas.IframeApi.ObjectModel.IMarginHV
New syntax
setMockup(mockup: IMockupTemplate, previewMockups?: IMockupTemplate[], options?: {
    updateRevertData?: boolean;
}): Promise<Product>;

Changes in the Web API 5

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

Migrating Applications from DE 4 to 5

Removing the Eval Function

In Customer's Canvas 4, you could access the Design Editor and its object model through the spEditor object in the eval function. Although you can still use this way, which is not recommended, the code executed in this function is likely to stop working because of changes in the IFrame API. In the current implementation, you have full access to the object model right through the IFrame API.

Let's see in what use cases you could use eval and how you can replace this function now.

Getting the User ID

Since the userId property has been removed from the object model in version 5, the following call returns undefined.

let editor = await CustomersCanvas.IframeApi.loadEditor(iframe, product, config);
console.log(await editor.eval("spEditor.model.product.userId"));

Instead, you can get the user ID from the runtime configuration as follows:

let editor = await CustomersCanvas.IframeApi.loadEditor(iframe, product, config);
console.log(await editor.configuration.getUserId());
Getting the Product Model

Instead of using the spEditor.model:

let productModel = await editor.eval(() => {
    return spEditor.model.product;
});

You can now obtain a product model as follows:

let product = await editor.getProduct();
let productModel = await product.getProductModel();

Note that despite the previous way, the model obtained through getProductModel represents only a snapshop of the product loaded into the editor. If you change the model, you need to apply these changes to the product by using the setProductModel method.

product.setProductModel(newProductModel);
Working with Design Elements

Instead of using the spEditor.productHandler object:

let item = spEditor.productHandler.getAllItems().find(x => x.name === "Logo");

For example, you can find an element by its name as follows:

let item = await product.getItemByName("Logo");

Changing the setMockup Calls

In Design Editor 5, you can set a mockup to a surface only through the IMockupTemplate interface. You can use the setMockup method as follows:

let newProduct = await product.currentSurface.setMockup(
    {
        up: "stamp",
        down: "envelope"
    },
    previewMockups: [{ down: "envelope" }]
);

Changing Endpoints of the StateFiles Controller

If your application uses the Web API for manipulating state files through the deprecated endpoint:

~/api/users/{userId}/{stateId}

Then you must replace it with the new endpoint:

~/api/users/{userId}/states/{stateId}

Was this page helpful?
Back to top Copyright © 2001–2025 Aurigma, Inc. All rights reserved.