@vsf-enterprise/smartedit-api
5.0.0
Major Changes
- CHANGED API Client
configuration
now requires also settings forOAuth
.
Minor Changes
- ADDED Automatic resolution of itemType references in SmartEdit components. The
getPage
function now automatically detects and resolves nested component references (such as CMSLinkComponent) without requiring explicit configuration. When the SAP Commerce Cloud API returns objects withitemType
anditemId
properties, they are automatically replaced with the resolved component data.
Before:
{
"navigationNode": {
"entries": [
{
"itemId": "SnowwearMensJacketsLink",
"itemSuperType": "AbstractCMSComponent",
"itemType": "CMSLinkComponent"
}
]
}
}
After (automatically resolved):
{
"navigationNode": {
"entries": [
{
"uid": "SnowwearMensJacketsLink",
"component": "CMSLinkComponent",
"text": "Men's Jackets",
"url": "/snow/men/jackets"
}
]
}
}
This feature works at any nesting level and requires no additional configuration - all itemType references are resolved automatically during page processing.
- ADDED
normalizeChildren
normalizer for resolving nested objects that are not components, slots or images. - ADDED
normalizeVideo
normalizer for resolving video objects. - ADDED
transformVideoUrl
function in theunified
configuration allowing to transform video URLs (e.g. by prepending them withSAPCC_MEDIA_HOST
environment variable). - CHANGED Components of type
CMSFlexComponent
are no longer normalized and are passed to the frontend as-is. - ADDED Support for
searchParams
ingetPage
method to pass additional parameters likecode
andpageType
for customized page content fetching
Patch Changes
- Updated dependencies:
- @vsf-enterprise/cms-components-utils@3.1.0
4.0.0
Major Changes
- CHANGED Component reference resolution now happens BEFORE normalization instead of during normalization. Normalizers now receive components with already resolved references, simplifying the normalization process.
- CHANGED
getReferenceFieldsForComponent
now supports object-style reference field definitions with explicittype
property. The recommended format is{ type: "string", path: "fieldName" }
instead of plain strings. String format is kept for backward compatibility only. - ADDED Support for nested field paths in
getReferenceFieldsForComponent
using dot notation (e.g., 'slides.componentId', 'sections.rows.cells.componentId') to resolve deeply nested component references. Please refer to the JSDoc for more examples.
Patch Changes
- FIXED Recursive resolving of nested components
- FIXED
normalizePage
normalization. Slots are enumerated now by the position instead of name, which should help in placing them in appropriate place within the Page Template. - FIXED Added
urlLink
to the response ofnormalizeComponent
normalizer.
3.0.0
Major Changes
- CHANGED Guarantee compatibility with
@alokai/connect
package. - CHANGED Updated the package for compatibility with Node.js 22.
Key Updates:
- Upgraded to the latest version of Node.js 22
- Updated CI pipelines to use Node.js 22 for consistency.
- Updated
.nvmrc
or.node-version
files to specify Node.js version22.14
. - Upgraded
@types/node
to version^22.13.17
for compatibility with the latest Node.js features.
Recommendations:
- Use Node.js version
22.14.0
or higher for optimal performance, security, and compatibility. - While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.
CHANGED Replaced core dependencies with a new
@alokai/connect
package.@vue-storefront/middleware
,@vue-storefront/sdk
,vue-storefront/logger
,vue-storefront/unified-data-model
,@vue-storefront/multistore
were replaced with@alokai/connect
. The replacement preserves the same functionality and interface as the original packages. To read more about the@alokai/connect
package, please refer to the documentation.
Patch Changes
- Updated dependencies:
- @vsf-enterprise/cms-components-utils@3.0.0
- @vsf-enterprise/sapcc-api@10.0.0
- @alokai/connect@1.0.0
- @vsf-enterprise/sap-commerce-webservices-sdk@7.0.0
3.0.0-rc.5
Patch Changes
- Updated dependencies:
- @alokai/connect@1.0.0-rc.4
- @vsf-enterprise/sapcc-api@10.0.0-rc.6
3.0.0-rc.4
Major Changes
- CHANGED Updated the package for compatibility with Node.js 22.
Key Updates:
- Upgraded to the latest version of Node.js 22
- Updated CI pipelines to use Node.js 22 for consistency.
- Updated
.nvmrc
or.node-version
files to specify Node.js version22.14
. - Upgraded
@types/node
to version^22.13.17
for compatibility with the latest Node.js features.
Recommendations:
- Use Node.js version
22.14.0
or higher for optimal performance, security, and compatibility. - While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.
Patch Changes
- Updated dependencies:
- @vsf-enterprise/sap-commerce-webservices-sdk@7.0.0-rc.0
- @vsf-enterprise/cms-components-utils@3.0.0-rc.1
- @vsf-enterprise/sapcc-api@10.0.0-rc.5
- @alokai/connect@1.0.0-rc.3
3.0.0-rc.3
Patch Changes
- Updated dependencies:
- @alokai/connect@1.0.0-rc.2
- @vsf-enterprise/sapcc-api@10.0.0-rc.4
3.0.0-rc.2
Patch Changes
- Updated dependencies:
- @alokai/connect@1.0.0-rc.1
- @vsf-enterprise/sapcc-api@10.0.0-rc.3
3.0.0-rc.1
Major Changes
Update packages to work with connect rc version
Patch Changes
- Updated dependencies:
- @vsf-enterprise/cms-components-utils@3.0.0-rc.0
- @vsf-enterprise/sapcc-api@10.0.0-rc.1
- @alokai/connect@1.0.0-rc.0
3.0.0-rc.0
Major Changes
CHANGED Replaced core dependencies with a new @alokai/connect
package. @vue-storefront/middleware
, @vue-storefront/sdk
, vue-storefront/logger
, vue-storefront/unified-data-model
were replaced with @alokai/connect
. The replacement preserves the same functionality and interface as the original packages. To read more about the @alokai/connect
package, please refer to the documentation. You will also find a migration guide in the documentation.
Patch Changes
- Updated dependencies:
- @vsf-enterprise/sapcc-api@10.0.0-rc.0
2.0.0
Patch Changes
- Updated dependencies:
- @vsf-enterprise/sapcc-api@9.1.0
1.0.2
Patch Changes
- FIXED Passing
locale
togetPage
method.
1.0.1
Patch Changes
- FIXED
@vue-storefront/unified-data-model
version misconsistency
1.0.0
Major Changes
- ADDED Initial package release.