Vue Storefront is now Alokai! Learn More
Change Log

Change Log

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

6.0.0-rc.5ri:link

Patch Changesri:link

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

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

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

6.0.0-rc.2ri:link

Patch Changesri:link

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

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

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

5.1.2ri:link

Patch Changesri:link

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

5.1.1ri:link

Patch Changesri:link

CHANGED logging level for unified getPage method.

5.1.0ri:link

Minor Changesri:link

  • CHANGED Replace console with Alokai Logger. To learn more about logger, visit Alokai Logger.

5.0.0ri:link

Major Changesri:link

CHANGED

  • Update @vue-storefront/middleware to ^5.1.0
  • Update @vue-storefront/unified-data-model to ^3.0.0

4.4.0ri:link

Minor Changesri:link

FIXED: To resolve images coming from the Amplience API and display unpublished from the Amplience Hub, it's necessary to use the defaultHost value instead of the standard CDN host.

4.3.0ri:link

Minor Changesri:link

  • CHANGED getPage will now try to first find the page by exact path. It will use the resolving logic specified in resolvePages only when exact page doesn't exist.

4.2.0ri:link

Minor Changesri:link

  • CHANGED Upgraded the path-to-regexp package to version 8.0.0. Note that page path patterns must now follow a different convention. For more details, please refer to the Release Notes for path-to-regexp@8.0.0.

4.1.4ri:link

Patch Changesri:link

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

4.1.3ri:link

Patch Changesri:link

  • REMOVED normalizeMetadata normalizer. Metadata can be added by overriding the normalizeContentItem normalizer.

4.1.2ri:link

Patch Changesri:link

  • FIXED Fetching content in unified extension for Amplience Visualization.

4.1.1ri:link

Patch Changesri:link

  • CHANGED getPage method requires a unified configuration with resolvePages and resolveFallbackPage defined.
  • FIXED RegExp path matching in resolvePages.

4.1.0ri:link

Minor Changesri:link

  • ADDED Unified extension which allows fetching data from Amplience and extracting components. The extension is available at the /unified namespace and adds two methods:
  • getPage - Fetches the page data from Amplience.
  • normalizePage - Normalizes the raw page data coming from Amplience.

To use the extension on the Storefront side:

  1. Export extension types in the storefront-middleware/types.ts file:
+ export type { UnifiedEndpoints as UnifiedCmsEndpoints } from '@vsf-enterprise/amplience-api';
  1. In the SDK config, add a new middlewareModule:
+ import type { UnifiedCmsEndpoints } from 'storefront-middleware/types';

+ unifiedCms: buildModule(middlewareModule<UnifiedCmsEndpoints>, {
+   apiUrl: `${config.middlewareUrl}/amplience/unified`,
+   defaultRequestConfig: {
+     headers: getRequestHeaders(),
+   },
+ }),
  // ...
  1. In your page component, use the getPage method to fetch the page data:
const page = await sdk.unifiedCms.getPage({
  path: "/",
  locale: "en-GB",
});

All components are extracted, so you don't need to use the extractComponent utility from amplienceModule anymore.

4.0.0ri:link

Major Changesri:link

  • CHANGED Improved methods documentation present in the Endpoints interface.
  • REMOVED The package no longer exports the AmplienceMethods interface. Use the Endpoints interface instead.
  • REMOVED The package no longer exports the ProxiedEndpoints interface. Use the ApiMethods interface instead.
  • REMOVED The package no longer exports the ContextualizedEndpoints interface. Use the ApiMethods interface instead.

3.0.0ri:link

Major Changesri:link

  • BREAKING Updated @vue-storefront/middleware version to 4.1.0. Make sure this version is used in your project.
{
  ...
  "dependencies": {
-   "@vue-storefront/middleware": "3.x.x",
+   "@vue-storefront/middleware": "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