Vue Storefront is now Alokai! Learn More
@vsf-enterprise/amplience-sdk

@vsf-enterprise/amplience-sdk

4.0.0ri:link

Major Changesri:link

  • CHANGED Guarantee compatibility with @alokai/connect package.
  • CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:ri:link

  • 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 version 22.14.
  • Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:ri:link

  • 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.

Minor Changesri:link

  • CHANGED Update axios version to "^1.7.9"

Patch Changesri:link

  • Updated dependencies:
    • @vsf-enterprise/cms-components-utils@3.0.0
    • @alokai/connect@1.0.0

4.0.0-rc.5ri:link

Patch Changesri:link

  • Updated dependencies:
    • @alokai/connect@1.0.0-rc.4

4.0.0-rc.4ri:link

Major Changesri:link

  • CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:ri:link

  • 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 version 22.14.
  • Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:ri:link

  • 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 Changesri:link

  • Updated dependencies:
    • @vsf-enterprise/cms-components-utils@3.0.0-rc.1
    • @alokai/connect@1.0.0-rc.3

4.0.0-rc.3ri:link

Minor Changesri:link

  • CHANGED Update axios version to "^1.7.9"

Patch Changesri:link

  • Updated dependencies:
    • @alokai/connect@1.0.0-rc.2

4.0.0-rc.2ri:link

Patch Changesri:link

  • Updated dependencies:
    • @alokai/connect@1.0.0-rc.1

4.0.0-rc.1ri:link

Major Changesri:link

Update packages to work with connect rc version

Patch Changesri:link

  • Updated dependencies:
    • @vsf-enterprise/cms-components-utils@3.0.0-rc.0
    • @alokai/connect@1.0.0-rc.0

4.0.0-rc.0ri:link

Major Changesri:link

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.

3.1.4ri:link

Patch Changesri:link

  • CHANGED Bump dc-delivery-sdk-js to ^0.14.0 to mitigate CVE-2023-45857

3.1.3ri:link

Patch Changesri:link

  • REMOVED the dependency to @vue-storefront/sdk-axios-request-sender. It was redundant and not used in the project.
  • DEPRECATED AmplienceModuleType interface. It's redundant and will be removed in next major version after 04.2025.

3.1.2ri:link

Patch Changesri:link

  • Updated dependencies:
    • @vsf-enterprise/cms-components-utils@2.0.0

3.1.1ri:link

Patch Changesri:link

  • CHANGED Updated the type of the callback accepted by the initLivePreview util. Its return type is now void and the updatedData parameter is no longer any.

3.1.0ri:link

Minor Changesri:link

  • ADDED Added initLivePreview utility function to the Amplience SDK.
  • CHANGED The extractComponents utility has been marked as @deprecated and will be removed in 4 years from now (July 2028). Use getPage method which returns unified CMS page data.
- const extractedData = sdk.amplience.utils.extractComponents(params);
+ const extractedData = sdk.unifiedCms.getPage(params);

3.0.0ri:link

Major Changesri:link

  • CHANGED Implemented Alokai's middlewareModule.
  • REMOVED The package no longer exports the MethodOptions interface. Use the MethodConfig interface imported from @vue-storefront/sdk.
- import type { MethodOptions } from "@vsf-enterprise/amplience-sdk";
+ import type { MethodConfig } from "@vue-storefront/sdk";

- const methodConfig: MethodOptions = { ... };
+ const methodCofig: MethodConfig = { ... };
  • REMOVED The package no longer exports the HTTP Client used by the SDK because it now comes from the middlewareModule. Read this guide to find out how to modify the behaviour of the HTTP Client coming from the middlewareModule.

2.0.2ri:link

Patch Changesri:link

  • CHANGED Updated @vue-storefront/middleware version to 4.1.0.

2.0.1ri:link

Patch Changesri:link

Update axios to ^0.28.0 to mitigate security vulnerability CVE-2023-45857

2.0.0ri:link

Major Changesri:link

  • CHANGED Changed minimum Node version from 16 to 18. The condition that was forcing the Node version to be lower than 19 is also removed.

1.0.0ri:link

Major Changesri:link

  • Initial release

1.0.0-beta.0ri:link

Major Changesri:link

  • Initial release